| Package | Description |
|---|---|
| org.apache.pulsar.client.admin |
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.
|
| Modifier and Type | Class and Description |
|---|---|
static class |
PulsarAdminException.ConflictException
Conflict Exception.
|
static class |
PulsarAdminException.ConnectException
Connect Exception.
|
static class |
PulsarAdminException.GettingAuthenticationDataException
Getting Authentication Data Exception.
|
static class |
PulsarAdminException.HttpErrorException
Http Error Exception.
|
static class |
PulsarAdminException.NotAllowedException
Not Allowed Exception.
|
static class |
PulsarAdminException.NotAuthorizedException
Not Authorized Exception.
|
static class |
PulsarAdminException.NotFoundException
Not Found Exception.
|
static class |
PulsarAdminException.PreconditionFailedException
Precondition Failed Exception.
|
static class |
PulsarAdminException.ServerSideErrorException
Server Side Error Exception.
|
static class |
PulsarAdminException.TimeoutException
Timeout Exception.
|
| Modifier and Type | Method and Description |
|---|---|
void |
Brokers.backlogQuotaCheck()
Manually trigger backlogQuotaCheck.
|
void |
Namespaces.clearNamespaceBacklog(String namespace)
Clear backlog for all topics on a namespace.
|
void |
Namespaces.clearNamespaceBacklogForSubscription(String namespace,
String subscription)
Clear backlog for a given subscription on all topics on a namespace.
|
void |
Namespaces.clearNamespaceBundleBacklog(String namespace,
String bundle)
Clear backlog for all topics on a namespace bundle.
|
void |
Namespaces.clearNamespaceBundleBacklogForSubscription(String namespace,
String bundle,
String subscription)
Clear backlog for a given subscription on all topics on a namespace bundle.
|
void |
Namespaces.clearOffloadDeleteLag(String namespace)
Clear the offload deletion lag for a namespace.
|
void |
Namespaces.clearProperties(String namespace)
Clear all properties of a namespace.
|
LongRunningProcessStatus |
Topics.compactionStatus(String topic)
Check the status of an ongoing compaction for a topic.
|
void |
Clusters.createCluster(String cluster,
ClusterData clusterData)
Create a new cluster.
|
void |
Clusters.createFailureDomain(String cluster,
String domainName,
FailureDomain domain)
Create a domain into cluster.
|
void |
Functions.createFunction(FunctionConfig functionConfig,
String fileName)
Create a new function.
|
void |
Functions.createFunctionWithUrl(FunctionConfig functionConfig,
String pkgUrl)
Create a new function with package url.
|
void |
Topics.createMissedPartitions(String topic)
Create missed partitions for partitioned topic.
|
void |
Namespaces.createNamespace(String namespace)
Create a new namespace.
|
void |
Namespaces.createNamespace(String namespace,
BundlesData bundlesData)
Create a new namespace.
|
void |
Namespaces.createNamespace(String namespace,
int numBundles)
Create a new namespace.
|
void |
Namespaces.createNamespace(String namespace,
Policies policies)
Create a new namespace.
|
void |
Namespaces.createNamespace(String namespace,
Set<String> clusters)
Create a new namespace.
|
void |
Clusters.createNamespaceIsolationPolicy(String cluster,
String policyName,
NamespaceIsolationData namespaceIsolationData)
Create a namespace isolation policy for a cluster.
|
void |
Topics.createNonPartitionedTopic(String topic)
Create a non-partitioned topic.
|
void |
Topics.createPartitionedTopic(String topic,
int numPartitions)
Create a partitioned topic.
|
void |
NonPersistentTopics.createPartitionedTopic(String topic,
int numPartitions)
Deprecated.
Create a partitioned topic.
|
void |
Properties.createProperty(String property,
TenantInfo config)
Deprecated.
Create a new property.
|
void |
ResourceGroups.createResourceGroup(String name,
ResourceGroup resourcegroup)
Create a new resourcegroup.
|
void |
Schemas.createSchema(String topic,
PostSchemaPayload schemaPayload)
Create a schema for a given topic.
|
void |
Schemas.createSchema(String topic,
SchemaInfo schemaInfo)
Create a schema for a given topic with the provided schema info.
|
void |
Sinks.createSink(SinkConfig sinkConfig,
String fileName)
Create a new sink.
|
void |
Sinks.createSinkWithUrl(SinkConfig sinkConfig,
String pkgUrl)
Create a new sink with package url.
|
void |
Sources.createSource(SourceConfig sourceConfig,
String fileName)
Create a new source.
|
void |
Sources.createSourceWithUrl(SourceConfig sourceConfig,
String pkgUrl)
Create a new source with package url.
|
void |
Topics.createSubscription(String topic,
String subscriptionName,
MessageId messageId)
Create a new subscription on a topic.
|
void |
Tenants.createTenant(String tenant,
TenantInfo config)
Create a new tenant.
|
void |
Topics.delete(String topic)
Delete a topic.
|
void |
Packages.delete(String packageName)
Delete the specified package.
|
default void |
Topics.delete(String topic,
boolean force) |
void |
Topics.delete(String topic,
boolean force,
boolean deleteSchema)
Delete a topic.
|
void |
Namespaces.deleteBookieAffinityGroup(String namespace)
Delete bookie affinity group configured for a namespace.
|
void |
Bookies.deleteBookieRackInfo(String bookieAddress)
Remove rack placement information for a specific bookie in the cluster.
|
void |
Clusters.deleteCluster(String cluster)
Delete an existing cluster.
|
void |
Brokers.deleteDynamicConfiguration(String configName)
It deletes dynamic configuration value into ZooKeeper.
|
void |
Clusters.deleteFailureDomain(String cluster,
String domainName)
Delete a domain in cluster.
|
void |
Functions.deleteFunction(String tenant,
String namespace,
String function)
Delete an existing function.
|
void |
Namespaces.deleteNamespace(String namespace)
Delete an existing namespace.
|
void |
Namespaces.deleteNamespace(String namespace,
boolean force)
Delete an existing namespace.
|
void |
Namespaces.deleteNamespaceAntiAffinityGroup(String namespace)
Delete anti-affinity group name for a namespace.
|
void |
Namespaces.deleteNamespaceBundle(String namespace,
String bundleRange)
Delete an existing bundle in a namespace.
|
void |
Namespaces.deleteNamespaceBundle(String namespace,
String bundleRange,
boolean force)
Delete an existing bundle in a namespace.
|
void |
Clusters.deleteNamespaceIsolationPolicy(String cluster,
String policyName)
Delete a namespace isolation policy for a cluster.
|
void |
Topics.deletePartitionedTopic(String topic)
Delete a partitioned topic.
|
default void |
Topics.deletePartitionedTopic(String topic,
boolean force) |
void |
Topics.deletePartitionedTopic(String topic,
boolean force,
boolean deleteSchema)
Delete a partitioned topic.
|
void |
Properties.deleteProperty(String property)
Deprecated.
Delete an existing property.
|
void |
ResourceGroups.deleteResourceGroup(String resourcegroup)
Delete an existing resourcegroup.
|
void |
Schemas.deleteSchema(String topic)
Delete the schema associated with a given topic.
|
void |
Sinks.deleteSink(String tenant,
String namespace,
String sink)
Delete an existing sink.
|
void |
Sources.deleteSource(String tenant,
String namespace,
String source)
Delete an existing source.
|
void |
Topics.deleteSubscription(String topic,
String subName)
Delete a subscription.
|
void |
Topics.deleteSubscription(String topic,
String subName,
boolean force)
Delete a subscription.
|
void |
Tenants.deleteTenant(String tenant)
Delete an existing tenant.
|
void |
Tenants.deleteTenant(String tenant,
boolean force)
Delete an existing tenant.
|
void |
Topics.disableDeduplication(String topic)
Deprecated.
|
void |
Packages.download(String packageName,
String path)
Download a package from the package management service.
|
void |
Functions.downloadFunction(String destinationFile,
String path)
Download Function Code.
|
void |
Functions.downloadFunction(String destinationFile,
String tenant,
String namespace,
String function)
Download Function Code.
|
void |
Topics.enableDeduplication(String topic,
boolean enabled)
Deprecated.
|
Message<byte[]> |
Topics.examineMessage(String topic,
String initialPosition,
long messagePosition)
Examine a specific message on a topic by position relative to the earliest or the latest message.
|
CompletableFuture<Message<byte[]>> |
Topics.examineMessageAsync(String topic,
String initialPosition,
long messagePosition)
Examine a specific message on a topic by position relative to the earliest or the latest message.
|
void |
Topics.expireMessages(String topic,
String subscriptionName,
long expireTimeInSeconds)
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
|
void |
Topics.expireMessages(String topic,
String subscriptionName,
MessageId messageId,
boolean isExcluded)
Expire all messages older than given N (expireTimeInSeconds) seconds for a given subscription.
|
void |
Topics.expireMessagesForAllSubscriptions(String topic,
long expireTimeInSeconds)
Expire all messages older than given N seconds for all subscriptions of the persistent-topic.
|
List<String> |
Brokers.getActiveBrokers(String cluster)
Get the list of active brokers in the cluster.
|
Map<String,String> |
Brokers.getAllDynamicConfigurations()
Get values of all overridden dynamic-configs.
|
AllocatorStats |
BrokerStats.getAllocatorStats(String allocatorName)
Get the stats for the Netty allocator.
|
List<SchemaInfo> |
Schemas.getAllSchemas(String topic)
Get all version schemas topic.
|
List<String> |
Namespaces.getAntiAffinityNamespaces(String tenant,
String cluster,
String namespaceAntiAffinityGroup)
Get all namespaces that grouped with given anti-affinity group.
|
Map<String,Collection<String>> |
Worker.getAssignments()
Get the function assignment among the cluster.
|
Map<BacklogQuota.BacklogQuotaType,BacklogQuota> |
Namespaces.getBacklogQuotaMap(String namespace)
Get backlog quota map on a namespace.
|
Map<BacklogQuota.BacklogQuotaType,BacklogQuota> |
Topics.getBacklogQuotaMap(String topic)
Get backlog quota map for a topic.
|
Map<BacklogQuota.BacklogQuotaType,BacklogQuota> |
Topics.getBacklogQuotaMap(String topic,
boolean applied)
Get applied backlog quota map for a topic.
|
Long |
Topics.getBacklogSizeByMessageId(String topic,
MessageId messageId)
Get backlog size by a message ID.
|
BookieAffinityGroupData |
Namespaces.getBookieAffinityGroup(String namespace)
Get bookie affinity group configured for a namespace.
|
BookieInfo |
Bookies.getBookieRackInfo(String bookieAddress)
Gets the rack placement information for a specific bookie in the cluster.
|
BookiesClusterInfo |
Bookies.getBookies()
Gets discovery information for all the bookies in the cluster.
|
BookiesRackConfiguration |
Bookies.getBookiesRackInfo()
Gets the rack placement information for all the bookies in the cluster.
|
List<BrokerNamespaceIsolationData> |
Clusters.getBrokersWithNamespaceIsolationPolicy(String cluster)
Returns list of active brokers with namespace-isolation policies attached to it.
|
BrokerNamespaceIsolationData |
Clusters.getBrokerWithNamespaceIsolationPolicy(String cluster,
String broker)
Returns active broker with namespace-isolation policies attached to it.
|
List<ConnectorDefinition> |
Sinks.getBuiltInSinks()
Fetches a list of supported Pulsar IO sinks currently running in cluster mode.
|
List<ConnectorDefinition> |
Sources.getBuiltInSources()
Fetches a list of supported Pulsar IO sources currently running in cluster mode.
|
String |
Lookup.getBundleRange(String topic)
Get a bundle range of a topic.
|
BundlesData |
Namespaces.getBundles(String namespace)
Get the list of bundles.
|
List<WorkerInfo> |
Worker.getCluster()
Get List of all workers belonging to this cluster.
|
ClusterData |
Clusters.getCluster(String cluster)
Get the configuration data for the specified cluster.
|
WorkerInfo |
Worker.getClusterLeader()
Get the worker who is the leader of the cluster.
|
List<String> |
Clusters.getClusters()
Get the list of clusters.
|
Long |
Namespaces.getCompactionThreshold(String namespace)
Get the compactionThreshold for a namespace.
|
Long |
Topics.getCompactionThreshold(String topic)
Get the compactionThreshold for a topic.
|
Long |
Topics.getCompactionThreshold(String topic,
boolean applied)
Get the compactionThreshold for a topic.
|
String |
ProxyStats.getConnections()
Returns Connections metrics.
|
List<ConnectorDefinition> |
Functions.getConnectorsList()
Deprecated.
|
TransactionCoordinatorInternalStats |
Transactions.getCoordinatorInternalStats(int coordinatorId,
boolean metadata)
Get transaction coordinator internal stats.
|
Map<Integer,TransactionCoordinatorStats> |
Transactions.getCoordinatorStats()
Get transaction metadataStore stats.
|
TransactionCoordinatorStats |
Transactions.getCoordinatorStatsById(int coordinatorId)
Get transaction metadataStore stats.
|
Boolean |
Topics.getDeduplicationEnabled(String topic)
Deprecated.
|
Integer |
Namespaces.getDeduplicationSnapshotInterval(String namespace)
Get the deduplicationSnapshotInterval for a namespace.
|
Integer |
Topics.getDeduplicationSnapshotInterval(String topic)
Get the deduplication snapshot interval for specified topic.
|
Boolean |
Namespaces.getDeduplicationStatus(String namespace)
Get the deduplication status for all topics within a namespace .
|
Boolean |
Topics.getDeduplicationStatus(String topic)
get deduplication enabled of a topic.
|
Boolean |
Topics.getDeduplicationStatus(String topic,
boolean applied)
get applied deduplication enabled of a topic.
|
ResourceQuota |
ResourceQuotas.getDefaultResourceQuota()
Get default resource quota for new resource bundles.
|
DelayedDeliveryPolicies |
Namespaces.getDelayedDelivery(String namespace)
Get the delayed delivery messages for all topics within a namespace.
|
DelayedDeliveryPolicies |
Topics.getDelayedDeliveryPolicy(String topic)
Get the delayed delivery policy for a specified topic.
|
DelayedDeliveryPolicies |
Topics.getDelayedDeliveryPolicy(String topic,
boolean applied)
Get the delayed delivery policy applied for a specified topic.
|
DispatchRate |
Namespaces.getDispatchRate(String namespace)
Get message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
|
DispatchRate |
Topics.getDispatchRate(String topic)
Get message-dispatch-rate (topic can dispatch this many messages per second).
|
DispatchRate |
Topics.getDispatchRate(String topic,
boolean applied)
Get applied message-dispatch-rate (topic can dispatch this many messages per second).
|
List<String> |
Brokers.getDynamicConfigurationNames()
Get list of updatable configuration name.
|
FailureDomain |
Clusters.getFailureDomain(String cluster,
String domainName)
Get the domain registered into a cluster.
|
Map<String,FailureDomain> |
Clusters.getFailureDomains(String cluster)
Get all registered domains in cluster.
|
FunctionConfig |
Functions.getFunction(String tenant,
String namespace,
String function)
Get the configuration for the specified function.
|
List<String> |
Functions.getFunctions(String tenant,
String namespace)
Get the list of functions.
|
List<WorkerFunctionInstanceStats> |
Worker.getFunctionsStats()
Get all functions stats on a worker.
|
FunctionState |
Functions.getFunctionState(String tenant,
String namespace,
String function,
String key)
Fetch the current state associated with a Pulsar Function.
|
FunctionStats |
Functions.getFunctionStats(String tenant,
String namespace,
String function)
Gets the current stats of a function.
|
FunctionInstanceStatsData |
Functions.getFunctionStats(String tenant,
String namespace,
String function,
int id)
Gets the current stats of a function instance.
|
FunctionStatus |
Functions.getFunctionStatus(String tenant,
String namespace,
String function)
Gets the current status of a function.
|
FunctionStatus.FunctionInstanceStatus.FunctionInstanceStatusData |
Functions.getFunctionStatus(String tenant,
String namespace,
String function,
int id)
Gets the current status of a function instance.
|
InactiveTopicPolicies |
Namespaces.getInactiveTopicPolicies(String namespace)
Get the inactive deletion strategy for all topics within a namespace synchronously.
|
InactiveTopicPolicies |
Topics.getInactiveTopicPolicies(String topic)
get inactive topic policies of a topic.
|
InactiveTopicPolicies |
Topics.getInactiveTopicPolicies(String topic,
boolean applied)
Get inactive topic policies applied for a topic.
|
InternalConfigurationData |
Brokers.getInternalConfigurationData()
Get the internal configuration data.
|
String |
Topics.getInternalInfo(String topic)
Get a JSON representation of the topic metadata stored in ZooKeeper.
|
PersistentTopicInternalStats |
Topics.getInternalStats(String topic)
Get the internal stats for the topic.
|
PersistentTopicInternalStats |
NonPersistentTopics.getInternalStats(String topic)
Deprecated.
Get the internal stats for the topic.
|
PersistentTopicInternalStats |
Topics.getInternalStats(String topic,
boolean metadata)
Get the internal stats for the topic.
|
boolean |
Namespaces.getIsAllowAutoUpdateSchema(String namespace)
Get whether allow auto update schema.
|
MessageId |
Topics.getLastMessageId(String topic)
Get the last commit message Id of a topic.
|
BrokerInfo |
Brokers.getLeaderBroker()
Get the information of the leader broker.
|
CompletableFuture<BrokerInfo> |
Brokers.getLeaderBrokerAsync()
Get the service url of the leader broker asynchronously.
|
List<String> |
Topics.getList(String namespace)
Get the both persistent and non-persistent topics under a namespace.
|
List<String> |
NonPersistentTopics.getList(String namespace)
Deprecated.
Get list of topics exist into given namespace.
|
List<String> |
Topics.getList(String namespace,
TopicDomain topicDomain)
Get the list of topics under a namespace.
|
List<String> |
Topics.getListInBundle(String namespace,
String bundleRange)
Get list of topics exist into given bundle.
|
List<String> |
NonPersistentTopics.getListInBundle(String namespace,
String bundleRange)
Deprecated.
Get list of topics exist into given bundle.
|
LoadManagerReport |
BrokerStats.getLoadReport()
Get load for this broker.
|
Integer |
Topics.getMaxConsumers(String topic)
Get the max number of consumer for specified topic.
|
Integer |
Topics.getMaxConsumers(String topic,
boolean applied)
Get the max number of consumer applied for specified topic.
|
Integer |
Namespaces.getMaxConsumersPerSubscription(String namespace)
Get the maxConsumersPerSubscription for a namespace.
|
Integer |
Topics.getMaxConsumersPerSubscription(String topic)
Get the maxConsumersPerSubscription for a topic.
|
Integer |
Namespaces.getMaxConsumersPerTopic(String namespace)
Get the maxProducersPerTopic for a namespace.
|
Integer |
Topics.getMaxMessageSize(String topic)
Get the max message size for specified topic.
|
Integer |
Topics.getMaxProducers(String topic)
Get the max number of producer for specified topic.
|
Integer |
Topics.getMaxProducers(String topic,
boolean applied)
Get the max number of producer applied for specified topic.
|
Integer |
Namespaces.getMaxProducersPerTopic(String namespace)
Get the maxProducersPerTopic for a namespace.
|
Integer |
Namespaces.getMaxSubscriptionsPerTopic(String namespace)
Get the maxSubscriptionsPerTopic for a namespace.
|
Integer |
Topics.getMaxSubscriptionsPerTopic(String topic)
Get the max number of subscriptions for specified topic.
|
int |
Namespaces.getMaxTopicsPerNamespace(String namespace)
Get maxTopicsPerNamespace for a namespace.
|
Integer |
Topics.getMaxUnackedMessagesOnConsumer(String topic)
get max unacked messages on consumer of a topic.
|
Integer |
Topics.getMaxUnackedMessagesOnConsumer(String topic,
boolean applied)
get applied max unacked messages on consumer of a topic.
|
Integer |
Topics.getMaxUnackedMessagesOnSubscription(String topic)
get max unacked messages on subscription of a topic.
|
Integer |
Topics.getMaxUnackedMessagesOnSubscription(String topic,
boolean applied)
get max unacked messages on subscription of a topic.
|
Integer |
Namespaces.getMaxUnackedMessagesPerConsumer(String namespace)
Get the maxUnackedMessagesPerConsumer for a namespace.
|
Integer |
Namespaces.getMaxUnackedMessagesPerSubscription(String namespace)
Get the maxUnackedMessagesPerSubscription for a namespace.
|
String |
BrokerStats.getMBeans()
Requests JSON string server mbean dump.
|
Message<byte[]> |
Topics.getMessageById(String topic,
long ledgerId,
long entryId)
Get a message by its messageId via a topic subscription.
|
MessageId |
Topics.getMessageIdByTimestamp(String topic,
long timestamp)
Get message ID published at or just after this absolute timestamp (in ms).
|
Integer |
Topics.getMessageTTL(String topic)
Get message TTL for a topic.
|
Integer |
Topics.getMessageTTL(String topic,
boolean applied)
Get message TTL applied for a topic.
|
PackageMetadata |
Packages.getMetadata(String packageName)
Get a package metadata information.
|
Collection<Metrics> |
Worker.getMetrics()
Get worker metrics.
|
String |
BrokerStats.getMetrics()
Returns Monitoring metrics.
|
String |
Namespaces.getNamespaceAntiAffinityGroup(String namespace)
Get anti-affinity group name for a namespace.
|
ResourceQuota |
ResourceQuotas.getNamespaceBundleResourceQuota(String namespace,
String bundle)
Get resource quota of a namespace bundle.
|
Map<String,NamespaceIsolationData> |
Clusters.getNamespaceIsolationPolicies(String cluster)
Get the namespace isolation policies of a cluster.
|
NamespaceIsolationData |
Clusters.getNamespaceIsolationPolicy(String cluster,
String policyName)
Get a single namespace isolation policy for a cluster.
|
Integer |
Namespaces.getNamespaceMessageTTL(String namespace)
Get the message TTL for a namespace.
|
List<String> |
Namespaces.getNamespaceReplicationClusters(String namespace)
Get the replication clusters for a namespace.
|
String |
Namespaces.getNamespaceResourceGroup(String namespace)
Get the ResourceGroup for a namespace.
|
List<String> |
Namespaces.getNamespaces(String tenant)
Get the list of namespaces.
|
List<String> |
Namespaces.getNamespaces(String tenant,
String cluster)
Deprecated.
|
Long |
Namespaces.getOffloadDeleteLagMs(String namespace)
Get the offload deletion lag for a namespace, in milliseconds.
|
OffloadPolicies |
Namespaces.getOffloadPolicies(String namespace)
Get the offload configuration for a namespace.
|
OffloadPolicies |
Topics.getOffloadPolicies(String topic)
get offload policies of a topic.
|
OffloadPolicies |
Topics.getOffloadPolicies(String topic,
boolean applied)
get applied offload policies of a topic.
|
long |
Namespaces.getOffloadThreshold(String namespace)
Get the offloadThreshold for a namespace.
|
Map<String,NamespaceOwnershipStatus> |
Brokers.getOwnedNamespaces(String cluster,
String brokerUrl)
Get the map of owned namespaces and their status from a single broker in the cluster.
|
PartitionedTopicInternalStats |
Topics.getPartitionedInternalStats(String topic)
Get the stats for the partitioned topic.
|
default PartitionedTopicStats |
Topics.getPartitionedStats(String topic,
boolean perPartition) |
PartitionedTopicStats |
Topics.getPartitionedStats(String topic,
boolean perPartition,
boolean getPreciseBacklog,
boolean subscriptionBacklogSize)
Get the stats for the partitioned topic
Response Example:
|
List<String> |
Topics.getPartitionedTopicList(String namespace)
Get the list of partitioned topics under a namespace.
|
PartitionedTopicMetadata |
Topics.getPartitionedTopicMetadata(String topic)
Get metadata of a partitioned topic.
|
PartitionedTopicMetadata |
NonPersistentTopics.getPartitionedTopicMetadata(String topic)
Deprecated.
Get metadata of a partitioned topic.
|
Set<String> |
Clusters.getPeerClusterNames(String cluster)
Get peer-cluster names.
|
TransactionPendingAckInternalStats |
Transactions.getPendingAckInternalStats(String topic,
String subName,
boolean metadata)
Get pending ack internal stats.
|
TransactionPendingAckStats |
Transactions.getPendingAckStats(String topic,
String subName)
Get transaction pending ack stats.
|
String |
BrokerStats.getPendingBookieOpsStats()
Get pending bookie client op stats by namespace.
|
Map<String,Set<AuthAction>> |
Namespaces.getPermissions(String namespace)
Get permissions on a namespace.
|
Map<String,Set<AuthAction>> |
Topics.getPermissions(String topic)
Get permissions on a topic.
|
PersistencePolicies |
Namespaces.getPersistence(String namespace)
Get the persistence configuration for a namespace.
|
PersistencePolicies |
Topics.getPersistence(String topic)
Get the configuration of persistence policies for specified topic.
|
PersistencePolicies |
Topics.getPersistence(String topic,
boolean applied)
Get the applied configuration of persistence policies for specified topic.
|
Policies |
Namespaces.getPolicies(String namespace)
Get policies for a namespace.
|
List<String> |
Properties.getProperties()
Deprecated.
Get the list of properties.
|
Map<String,String> |
Namespaces.getProperties(String namespace)
Get all properties of a namespace.
|
String |
Namespaces.getProperty(String namespace,
String key)
Get property value for a given key.
|
TenantInfo |
Properties.getPropertyAdmin(String property)
Deprecated.
Get the config of the property.
|
PublishRate |
Namespaces.getPublishRate(String namespace)
Get message-publish-rate (topics under this namespace can publish this many messages per second).
|
PublishRate |
Topics.getPublishRate(String topic)
Get message-publish-rate (topics can publish this many messages per second).
|
String |
Namespaces.getReplicationConfigVersion(String namespace)
Get the replication configuration version for a given namespace.
|
DispatchRate |
Namespaces.getReplicatorDispatchRate(String namespace)
Get replicator-message-dispatch-rate.
|
DispatchRate |
Topics.getReplicatorDispatchRate(String topic)
Get replicatorDispatchRate for the topic.
|
DispatchRate |
Topics.getReplicatorDispatchRate(String topic,
boolean applied)
Get applied replicatorDispatchRate for the topic.
|
ResourceGroup |
ResourceGroups.getResourceGroup(String resourcegroup)
Get configuration for a resourcegroup.
|
List<String> |
ResourceGroups.getResourceGroups()
Get the list of resourcegroups.
|
RetentionPolicies |
Namespaces.getRetention(String namespace)
Get the retention configuration for a namespace.
|
RetentionPolicies |
Topics.getRetention(String topic)
Get the retention configuration for a topic.
|
RetentionPolicies |
Topics.getRetention(String topic,
boolean applied)
Get the applied retention configuration for a topic.
|
Map<String,String> |
Brokers.getRuntimeConfigurations()
Get values of runtime configuration.
|
SchemaAutoUpdateCompatibilityStrategy |
Namespaces.getSchemaAutoUpdateCompatibilityStrategy(String namespace)
Deprecated.
|
SchemaCompatibilityStrategy |
Namespaces.getSchemaCompatibilityStrategy(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.
|
SchemaInfo |
Schemas.getSchemaInfo(String topic)
Retrieve the latest schema of a topic.
|
SchemaInfo |
Schemas.getSchemaInfo(String topic,
long version)
Retrieve the schema of a topic at a given version.
|
SchemaInfoWithVersion |
Schemas.getSchemaInfoWithVersion(String topic)
Retrieve the latest schema with verison of a topic.
|
boolean |
Namespaces.getSchemaValidationEnforced(String namespace)
Get schema validation enforced for namespace.
|
SinkConfig |
Sinks.getSink(String tenant,
String namespace,
String sink)
Get the configuration for the specified sink.
|
Set<String> |
Functions.getSinks()
Deprecated.
|
SinkStatus |
Sinks.getSinkStatus(String tenant,
String namespace,
String sink)
Gets the current status of a sink.
|
SinkStatus.SinkInstanceStatus.SinkInstanceStatusData |
Sinks.getSinkStatus(String tenant,
String namespace,
String sink,
int id)
Gets the current status of a sink instance.
|
Map<String,TransactionMetadata> |
Transactions.getSlowTransactions(long timeout,
TimeUnit timeUnit)
Get slow transactions.
|
Map<String,TransactionMetadata> |
Transactions.getSlowTransactionsByCoordinatorId(Integer coordinatorId,
long timeout,
TimeUnit timeUnit)
Get slow transactions by coordinator id.
|
SourceConfig |
Sources.getSource(String tenant,
String namespace,
String source)
Get the configuration for the specified source.
|
Set<String> |
Functions.getSources()
Deprecated.
|
SourceStatus |
Sources.getSourceStatus(String tenant,
String namespace,
String source)
Gets the current status of a source.
|
SourceStatus.SourceInstanceStatus.SourceInstanceStatusData |
Sources.getSourceStatus(String tenant,
String namespace,
String source,
int id)
Gets the current status of a source instance.
|
default TopicStats |
Topics.getStats(String topic) |
NonPersistentTopicStats |
NonPersistentTopics.getStats(String topic)
Deprecated.
Get the stats for the topic.
|
default TopicStats |
Topics.getStats(String topic,
boolean getPreciseBacklog) |
TopicStats |
Topics.getStats(String topic,
boolean getPreciseBacklog,
boolean subscriptionBacklogSize)
Get the stats for the topic.
|
SubscribeRate |
Namespaces.getSubscribeRate(String namespace)
Get namespace-subscribe-rate (topics under this namespace allow subscribe times per consumer in a period).
|
SubscribeRate |
Topics.getSubscribeRate(String topic)
Get topic-subscribe-rate (topics allow subscribe times per consumer in a period).
|
SubscribeRate |
Topics.getSubscribeRate(String topic,
boolean applied)
Get applied topic-subscribe-rate (topics allow subscribe times per consumer in a period).
|
DispatchRate |
Namespaces.getSubscriptionDispatchRate(String namespace)
Get subscription-message-dispatch-rate.
|
DispatchRate |
Topics.getSubscriptionDispatchRate(String topic)
Get subscription-message-dispatch-rate for the topic.
|
DispatchRate |
Topics.getSubscriptionDispatchRate(String namespace,
boolean applied)
Get applied subscription-message-dispatch-rate.
|
Integer |
Namespaces.getSubscriptionExpirationTime(String namespace)
Get the subscription expiration time for a namespace.
|
List<String> |
Topics.getSubscriptions(String topic)
Get the list of subscriptions.
|
Set<SubscriptionType> |
Namespaces.getSubscriptionTypesEnabled(String namespace)
Get the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
|
Set<SubscriptionType> |
Topics.getSubscriptionTypesEnabled(String topic)
Get is enable sub types.
|
TenantInfo |
Tenants.getTenantInfo(String tenant)
Get the config of the tenant.
|
List<String> |
Tenants.getTenants()
Get the list of tenants.
|
String |
ProxyStats.getTopics()
Returns Topics metrics.
|
String |
BrokerStats.getTopics()
Returns JSON string topics stats.
|
List<String> |
Namespaces.getTopics(String namespace)
Get the list of topics.
|
TransactionBufferStats |
Transactions.getTransactionBufferStats(String topic)
Get transaction buffer stats.
|
TransactionInBufferStats |
Transactions.getTransactionInBufferStats(TxnID txnID,
String topic)
Get transaction in buffer stats.
|
TransactionInPendingAckStats |
Transactions.getTransactionInPendingAckStats(TxnID txnID,
String topic,
String subName)
Get transaction in pending ack stats.
|
TransactionMetadata |
Transactions.getTransactionMetadata(TxnID txnID)
Get transaction metadata.
|
String |
Brokers.getVersion()
Get version of broker.
|
Long |
Schemas.getVersionBySchema(String topic,
PostSchemaPayload schemaPayload)
Find schema version topic.
|
Long |
Schemas.getVersionBySchema(String topic,
SchemaInfo schemaInfo)
Find schema version topic.
|
void |
Topics.grantPermission(String topic,
String role,
Set<AuthAction> actions)
Grant permission on a topic.
|
void |
Namespaces.grantPermissionOnNamespace(String namespace,
String role,
Set<AuthAction> actions)
Grant permission on a namespace.
|
void |
Namespaces.grantPermissionOnSubscription(String namespace,
String subscription,
Set<String> roles)
Grant permission to role to access subscription's admin-api.
|
void |
Brokers.healthcheck()
Deprecated.
|
void |
Brokers.healthcheck(TopicVersion topicVersion)
Run a healthcheck on the broker.
|
List<String> |
Packages.listPackages(String type,
String namespace)
List all the packages with the given type in a namespace.
|
List<String> |
Packages.listPackageVersions(String packageName)
List all the versions of a package.
|
List<String> |
Sinks.listSinks(String tenant,
String namespace)
Get the list of sinks.
|
List<String> |
Sources.listSources(String tenant,
String namespace)
Get the list of sources.
|
Map<String,String> |
Lookup.lookupPartitionedTopic(String topic)
Lookup a partitioned topic.
|
String |
Lookup.lookupTopic(String topic)
Lookup a topic.
|
OffloadProcessStatus |
Topics.offloadStatus(String topic)
Check the status of an ongoing offloading operation for a topic.
|
List<Message<byte[]>> |
Topics.peekMessages(String topic,
String subName,
int numMessages)
Peek messages from a topic subscription.
|
void |
Functions.putFunctionState(String tenant,
String namespace,
String function,
FunctionState state)
Puts the given state associated with a Pulsar Function.
|
void |
Sinks.reloadBuiltInSinks()
Reload the available built-in connectors, include Source and Sink.
|
void |
Sources.reloadBuiltInSources()
Reload the available built-in connectors, include Source and Source.
|
void |
Namespaces.removeAutoSubscriptionCreation(String namespace)
Removes the autoSubscriptionCreation policy for a given namespace.
|
void |
Namespaces.removeAutoTopicCreation(String namespace)
Removes the autoTopicCreation policy for a given namespace.
|
default void |
Namespaces.removeBacklogQuota(String namespace) |
default void |
Topics.removeBacklogQuota(String topic) |
void |
Namespaces.removeBacklogQuota(String namespace,
BacklogQuota.BacklogQuotaType backlogQuotaType)
Remove a backlog quota policy from a namespace.
|
void |
Topics.removeBacklogQuota(String topic,
BacklogQuota.BacklogQuotaType backlogQuotaType)
Remove a backlog quota policy from a topic.
|
void |
Namespaces.removeCompactionThreshold(String namespace)
Delete the compactionThreshold for a namespace.
|
void |
Topics.removeCompactionThreshold(String topic)
Remove the compactionThreshold for a topic.
|
void |
Namespaces.removeDeduplicationSnapshotInterval(String namespace)
Remove the deduplicationSnapshotInterval for a namespace.
|
void |
Topics.removeDeduplicationSnapshotInterval(String topic)
Remove the deduplication snapshot interval for specified topic.
|
void |
Namespaces.removeDeduplicationStatus(String namespace)
Remove the deduplication status for all topics within a namespace.
|
void |
Topics.removeDeduplicationStatus(String topic)
remove deduplication enabled of a topic.
|
void |
Namespaces.removeDelayedDeliveryMessages(String namespace)
Remove the delayed delivery messages for all topics within a namespace.
|
void |
Topics.removeDelayedDeliveryPolicy(String topic)
Remove the delayed delivery policy for a specified topic.
|
void |
Namespaces.removeDispatchRate(String namespace)
Remove message-dispatch-rate.
|
void |
Topics.removeDispatchRate(String topic)
Remove message-dispatch-rate.
|
CompletableFuture<Void> |
Topics.removeDispatchRateAsync(String topic)
Remove message-dispatch-rate asynchronously.
|
void |
Namespaces.removeInactiveTopicPolicies(String namespace)
Remove inactive topic policies from a namespace.
|
void |
Topics.removeInactiveTopicPolicies(String topic)
remove inactive topic policies of a topic.
|
void |
Topics.removeMaxConsumers(String topic)
Remove the max number of consumer for specified topic.
|
void |
Namespaces.removeMaxConsumersPerSubscription(String namespace)
Remove maxConsumersPerSubscription for a namespace.
|
void |
Topics.removeMaxConsumersPerSubscription(String topic)
Remove the maxConsumersPerSubscription for a topic.
|
void |
Namespaces.removeMaxConsumersPerTopic(String namespace)
Remove maxConsumersPerTopic for a namespace.
|
void |
Topics.removeMaxMessageSize(String topic)
Remove the max message size for specified topic.
|
void |
Topics.removeMaxProducers(String topic)
Remove the max number of producer for specified topic.
|
void |
Namespaces.removeMaxProducersPerTopic(String namespace)
Remove maxProducersPerTopic for a namespace.
|
void |
Namespaces.removeMaxSubscriptionsPerTopic(String namespace)
Remove the maxSubscriptionsPerTopic for a namespace.
|
void |
Topics.removeMaxSubscriptionsPerTopic(String topic)
Remove the max number of subscriptions for specified topic.
|
void |
Namespaces.removeMaxTopicsPerNamespace(String namespace)
remove maxTopicsPerNamespace for a namespace.
|
void |
Topics.removeMaxUnackedMessagesOnConsumer(String topic)
remove max unacked messages on consumer of a topic.
|
void |
Topics.removeMaxUnackedMessagesOnSubscription(String topic)
remove max unacked messages on subscription of a topic.
|
void |
Namespaces.removeMaxUnackedMessagesPerConsumer(String namespace)
Remove maxUnackedMessagesPerConsumer for a namespace.
|
void |
Namespaces.removeMaxUnackedMessagesPerSubscription(String namespace)
Remove maxUnackedMessagesPerSubscription for a namespace.
|
void |
Topics.removeMessageTTL(String topic)
Remove message TTL for a topic.
|
void |
Namespaces.removeNamespaceMessageTTL(String namespace)
Remove the messages Time to Live for all the topics within a namespace.
|
void |
Namespaces.removeNamespaceResourceGroup(String namespace)
Remove the ResourceGroup on a namespace.
|
void |
Namespaces.removeOffloadPolicies(String namespace)
Remove the offload configuration for a namespace.
|
void |
Topics.removeOffloadPolicies(String topic)
remove offload policies of a topic.
|
void |
Namespaces.removePersistence(String namespace)
Remove the persistence configuration on a namespace.
|
void |
Topics.removePersistence(String topic)
Remove the configuration of persistence policies for specified topic.
|
String |
Namespaces.removeProperty(String namespace,
String key)
Remove a property for a given key.
|
void |
Namespaces.removePublishRate(String namespace)
Remove message-publish-rate (topics under this namespace can publish this many messages per second).
|
void |
Topics.removePublishRate(String topic)
Remove message-publish-rate.
|
CompletableFuture<Void> |
Topics.removePublishRateAsync(String topic)
Remove message-publish-rate asynchronously.
|
void |
Namespaces.removeReplicatorDispatchRate(String namespace)
Remove replicator-message-dispatch-rate.
|
void |
Topics.removeReplicatorDispatchRate(String topic)
Remove replicatorDispatchRate for a topic.
|
void |
Namespaces.removeRetention(String namespace)
Remove the retention configuration for all the topics on a namespace.
|
void |
Topics.removeRetention(String topic)
Remove the retention configuration for all the topics on a topic.
|
void |
Namespaces.removeSubscribeRate(String namespace)
Remove namespace-subscribe-rate (topics under this namespace will limit by subscribeRate).
|
void |
Topics.removeSubscribeRate(String topic)
Remove topic-subscribe-rate.
|
CompletableFuture<Void> |
Topics.removeSubscribeRateAsync(String topic)
Remove topic-subscribe-rate asynchronously.
|
void |
Namespaces.removeSubscriptionDispatchRate(String namespace)
Remove subscription-message-dispatch-rate.
|
void |
Topics.removeSubscriptionDispatchRate(String topic)
Remove subscription-message-dispatch-rate for a topic.
|
void |
Namespaces.removeSubscriptionExpirationTime(String namespace)
Remove the subscription expiration time for a namespace.
|
void |
Topics.resetCursor(String topic,
String subName,
long timestamp)
Reset cursor position on a topic subscription.
|
void |
Topics.resetCursor(String topic,
String subName,
MessageId messageId)
Reset cursor position on a topic subscription.
|
void |
Topics.resetCursor(String topic,
String subName,
MessageId messageId,
boolean isExcluded)
Reset cursor position on a topic subscription.
|
void |
ResourceQuotas.resetNamespaceBundleResourceQuota(String namespace,
String bundle)
Reset resource quota for a namespace bundle to default value.
|
void |
Functions.restartFunction(String tenant,
String namespace,
String function)
Restart all function instances.
|
void |
Functions.restartFunction(String tenant,
String namespace,
String function,
int instanceId)
Restart function instance.
|
void |
Sinks.restartSink(String tenant,
String namespace,
String sink)
Restart all sink instances.
|
void |
Sinks.restartSink(String tenant,
String namespace,
String sink,
int instanceId)
Restart sink instance.
|
void |
Sources.restartSource(String tenant,
String namespace,
String source)
Restart all source instances.
|
void |
Sources.restartSource(String tenant,
String namespace,
String source,
int instanceId)
Restart source instance.
|
void |
Namespaces.revokePermissionOnSubscription(String namespace,
String subscription,
String role)
Revoke permissions on a subscription's admin-api access.
|
void |
Topics.revokePermissions(String topic,
String role)
Revoke permissions on a topic.
|
void |
Namespaces.revokePermissionsOnNamespace(String namespace,
String role)
Revoke permissions on a namespace.
|
void |
Namespaces.setAutoSubscriptionCreation(String namespace,
AutoSubscriptionCreationOverride autoSubscriptionCreationOverride)
Sets the autoSubscriptionCreation policy for a given namespace, overriding broker settings.
|
void |
Namespaces.setAutoTopicCreation(String namespace,
AutoTopicCreationOverride autoTopicCreationOverride)
Sets the autoTopicCreation policy for a given namespace, overriding broker settings.
|
default void |
Namespaces.setBacklogQuota(String namespace,
BacklogQuota backlogQuota) |
default void |
Topics.setBacklogQuota(String topic,
BacklogQuota backlogQuota) |
void |
Namespaces.setBacklogQuota(String namespace,
BacklogQuota backlogQuota,
BacklogQuota.BacklogQuotaType backlogQuotaType)
Set a backlog quota for all the topics on a namespace.
|
void |
Topics.setBacklogQuota(String topic,
BacklogQuota backlogQuota,
BacklogQuota.BacklogQuotaType backlogQuotaType)
Set a backlog quota for a topic.
|
void |
Namespaces.setBookieAffinityGroup(String namespace,
BookieAffinityGroupData bookieAffinityGroup)
Set bookie affinity group for a namespace to isolate namespace write to bookies that are part of given affinity
group.
|
void |
Namespaces.setCompactionThreshold(String namespace,
long compactionThreshold)
Set the compactionThreshold for a namespace.
|
void |
Topics.setCompactionThreshold(String topic,
long compactionThreshold)
Set the compactionThreshold for a topic.
|
void |
Topics.setDeduplicationSnapshotInterval(String topic,
int interval)
Set the deduplication snapshot interval for specified topic.
|
void |
Namespaces.setDeduplicationSnapshotInterval(String namespace,
Integer interval)
Set the deduplicationSnapshotInterval for a namespace.
|
void |
Namespaces.setDeduplicationStatus(String namespace,
boolean enableDeduplication)
Set the deduplication status for all topics within a namespace.
|
void |
Topics.setDeduplicationStatus(String topic,
boolean enabled)
set deduplication enabled of a topic.
|
void |
ResourceQuotas.setDefaultResourceQuota(ResourceQuota quota)
Set default resource quota for new namespace bundles.
|
void |
Namespaces.setDelayedDeliveryMessages(String namespace,
DelayedDeliveryPolicies delayedDeliveryPolicies)
Set the delayed delivery messages for all topics within a namespace.
|
void |
Topics.setDelayedDeliveryPolicy(String topic,
DelayedDeliveryPolicies delayedDeliveryPolicies)
Set the delayed delivery policy for a specified topic.
|
void |
Namespaces.setDispatchRate(String namespace,
DispatchRate dispatchRate)
Set message-dispatch-rate (topics under this namespace can dispatch this many messages per second).
|
void |
Topics.setDispatchRate(String topic,
DispatchRate dispatchRate)
Set message-dispatch-rate (topic can dispatch this many messages per second).
|
void |
Namespaces.setEncryptionRequiredStatus(String namespace,
boolean encryptionRequired)
Set the encryption required status for all topics within a namespace.
|
void |
Namespaces.setInactiveTopicPolicies(String namespace,
InactiveTopicPolicies inactiveTopicPolicies)
As same as setInactiveTopicPoliciesAsync,but it is synchronous.
|
void |
Topics.setInactiveTopicPolicies(String topic,
InactiveTopicPolicies inactiveTopicPolicies)
set inactive topic policies of a topic.
|
void |
Namespaces.setIsAllowAutoUpdateSchema(String namespace,
boolean isAllowAutoUpdateSchema)
Set whether to allow automatic schema updates.
|
void |
Topics.setMaxConsumers(String topic,
int maxConsumers)
Set the max number of consumer for specified topic.
|
void |
Namespaces.setMaxConsumersPerSubscription(String namespace,
int maxConsumersPerSubscription)
Set maxConsumersPerSubscription for a namespace.
|
void |
Topics.setMaxConsumersPerSubscription(String topic,
int maxConsumersPerSubscription)
Set maxConsumersPerSubscription for a topic.
|
void |
Namespaces.setMaxConsumersPerTopic(String namespace,
int maxConsumersPerTopic)
Set maxConsumersPerTopic for a namespace.
|
void |
Topics.setMaxMessageSize(String topic,
int maxMessageSize)
Set the max message size for specified topic.
|
void |
Topics.setMaxProducers(String topic,
int maxProducers)
Set the max number of producer for specified topic.
|
void |
Namespaces.setMaxProducersPerTopic(String namespace,
int maxProducersPerTopic)
Set maxProducersPerTopic for a namespace.
|
void |
Namespaces.setMaxSubscriptionsPerTopic(String namespace,
int maxSubscriptionsPerTopic)
Set the maxSubscriptionsPerTopic for a namespace.
|
void |
Topics.setMaxSubscriptionsPerTopic(String topic,
int maxSubscriptionsPerTopic)
Set the max number of subscriptions for specified topic.
|
void |
Namespaces.setMaxTopicsPerNamespace(String namespace,
int maxTopicsPerNamespace)
Set maxTopicsPerNamespace for a namespace.
|
void |
Topics.setMaxUnackedMessagesOnConsumer(String topic,
int maxNum)
set max unacked messages on consumer of a topic.
|
void |
Topics.setMaxUnackedMessagesOnSubscription(String topic,
int maxNum)
set max unacked messages on subscription of a topic.
|
void |
Namespaces.setMaxUnackedMessagesPerConsumer(String namespace,
int maxUnackedMessagesPerConsumer)
Set maxUnackedMessagesPerConsumer for a namespace.
|
void |
Namespaces.setMaxUnackedMessagesPerSubscription(String namespace,
int maxUnackedMessagesPerSubscription)
Set maxUnackedMessagesPerSubscription for a namespace.
|
void |
Topics.setMessageTTL(String topic,
int messageTTLInSecond)
Set message TTL for a topic.
|
void |
Namespaces.setNamespaceAntiAffinityGroup(String namespace,
String namespaceAntiAffinityGroup)
Set anti-affinity group name for a namespace.
|
void |
ResourceQuotas.setNamespaceBundleResourceQuota(String namespace,
String bundle,
ResourceQuota quota)
Set resource quota for a namespace bundle.
|
void |
Namespaces.setNamespaceMessageTTL(String namespace,
int ttlInSeconds)
Set the messages Time to Live for all the topics within a namespace.
|
void |
Namespaces.setNamespaceReplicationClusters(String namespace,
Set<String> clusterIds)
Set the replication clusters for a namespace.
|
void |
Namespaces.setNamespaceResourceGroup(String namespace,
String resourcegroupname)
Set the ResourceGroup for a namespace.
|
void |
Namespaces.setOffloadDeleteLag(String namespace,
long lag,
TimeUnit unit)
Set the offload deletion lag for a namespace.
|
void |
Namespaces.setOffloadPolicies(String namespace,
OffloadPolicies offloadPolicies)
Set the offload configuration for all the topics in a namespace.
|
void |
Topics.setOffloadPolicies(String topic,
OffloadPolicies offloadPolicies)
set offload policies of a topic.
|
void |
Namespaces.setOffloadThreshold(String namespace,
long offloadThreshold)
Set the offloadThreshold for a namespace.
|
void |
Namespaces.setPersistence(String namespace,
PersistencePolicies persistence)
Set the persistence configuration for all the topics on a namespace.
|
void |
Topics.setPersistence(String topic,
PersistencePolicies persistencePolicies)
Set the configuration of persistence policies for specified topic.
|
void |
Namespaces.setProperties(String namespace,
Map<String,String> properties)
Set key value pair properties for a namespace.
|
void |
Namespaces.setProperty(String namespace,
String key,
String value)
Set key value pair property for a namespace.
|
void |
Namespaces.setPublishRate(String namespace,
PublishRate publishMsgRate)
Set message-publish-rate (topics under this namespace can publish this many messages per second).
|
void |
Topics.setPublishRate(String topic,
PublishRate publishMsgRate)
Set message-publish-rate (topics can publish this many messages per second).
|
void |
Topics.setReplicatedSubscriptionStatus(String topic,
String subName,
boolean enabled)
Enable or disable a replicated subscription on a topic.
|
void |
Namespaces.setReplicatorDispatchRate(String namespace,
DispatchRate dispatchRate)
Set replicator-message-dispatch-rate.
|
void |
Topics.setReplicatorDispatchRate(String topic,
DispatchRate dispatchRate)
Set replicatorDispatchRate for the topic.
|
void |
Namespaces.setRetention(String namespace,
RetentionPolicies retention)
Set the retention configuration for all the topics on a namespace.
|
void |
Topics.setRetention(String topic,
RetentionPolicies retention)
Set the retention configuration on a topic.
|
void |
Namespaces.setSchemaAutoUpdateCompatibilityStrategy(String namespace,
SchemaAutoUpdateCompatibilityStrategy strategy)
Deprecated.
|
void |
Namespaces.setSchemaCompatibilityStrategy(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.
|
void |
Namespaces.setSchemaValidationEnforced(String namespace,
boolean schemaValidationEnforced)
Set schema validation enforced for namespace.
|
void |
Namespaces.setSubscribeRate(String namespace,
SubscribeRate subscribeRate)
Set namespace-subscribe-rate (topics under this namespace will limit by subscribeRate).
|
void |
Topics.setSubscribeRate(String topic,
SubscribeRate subscribeRate)
Set topic-subscribe-rate (topic will limit by subscribeRate).
|
void |
Namespaces.setSubscriptionAuthMode(String namespace,
SubscriptionAuthMode subscriptionAuthMode)
Set the given subscription auth mode on all topics on a namespace.
|
void |
Namespaces.setSubscriptionDispatchRate(String namespace,
DispatchRate dispatchRate)
Set subscription-message-dispatch-rate.
|
void |
Topics.setSubscriptionDispatchRate(String topic,
DispatchRate dispatchRate)
Set subscription-message-dispatch-rate for the topic.
|
void |
Namespaces.setSubscriptionExpirationTime(String namespace,
int expirationTime)
Set the subscription expiration time in minutes for all the topics within a namespace.
|
void |
Namespaces.setSubscriptionTypesEnabled(String namespace,
Set<SubscriptionType> subscriptionTypesEnabled)
Sets the subscriptionTypesEnabled policy for a given namespace, overriding broker settings.
|
void |
Topics.setSubscriptionTypesEnabled(String topic,
Set<SubscriptionType> subscriptionTypesEnabled)
Set is enable sub types.
|
void |
Topics.skipAllMessages(String topic,
String subName)
Skip all messages on a topic subscription.
|
void |
Topics.skipMessages(String topic,
String subName,
long numMessages)
Skip messages on a topic subscription.
|
void |
Namespaces.splitNamespaceBundle(String namespace,
String bundle,
boolean unloadSplitBundles,
String splitAlgorithmName)
Split namespace bundle.
|
void |
Functions.startFunction(String tenant,
String namespace,
String function)
Start all function instances.
|
void |
Functions.startFunction(String tenant,
String namespace,
String function,
int instanceId)
Start function instance.
|
void |
Sinks.startSink(String tenant,
String namespace,
String sink)
Start all sink instances.
|
void |
Sinks.startSink(String tenant,
String namespace,
String sink,
int instanceId)
Start sink instance.
|
void |
Sources.startSource(String tenant,
String namespace,
String source)
Start all source instances.
|
void |
Sources.startSource(String tenant,
String namespace,
String source,
int instanceId)
Start source instance.
|
void |
Functions.stopFunction(String tenant,
String namespace,
String function)
Stop all function instances.
|
void |
Functions.stopFunction(String tenant,
String namespace,
String function,
int instanceId)
Stop function instance.
|
void |
Sinks.stopSink(String tenant,
String namespace,
String sink)
Stop all sink instances.
|
void |
Sinks.stopSink(String tenant,
String namespace,
String sink,
int instanceId)
Stop sink instance.
|
void |
Sources.stopSource(String tenant,
String namespace,
String source)
Stop all source instances.
|
void |
Sources.stopSource(String tenant,
String namespace,
String source,
int instanceId)
Stop source instance.
|
MessageId |
Topics.terminateTopic(String topic)
Terminate the topic and prevent any more messages being published on it.
|
IsCompatibilityResponse |
Schemas.testCompatibility(String topic,
PostSchemaPayload schemaPayload)
Judge schema compatibility topic.
|
IsCompatibilityResponse |
Schemas.testCompatibility(String topic,
SchemaInfo schemaInfo)
Judge schema compatibility topic.
|
void |
Topics.triggerCompaction(String topic)
Trigger compaction to run for a topic.
|
String |
Functions.triggerFunction(String tenant,
String namespace,
String function,
String topic,
String triggerValue,
String triggerFile)
Triggers the function by writing to the input topic.
|
void |
Topics.triggerOffload(String topic,
MessageId messageId)
Trigger offloading messages in topic to longterm storage.
|
void |
Topics.truncate(String topic)
Truncate a topic.
|
void |
Namespaces.unload(String namespace)
Unload a namespace from the current serving broker.
|
void |
Topics.unload(String topic)
Unload a topic.
|
void |
NonPersistentTopics.unload(String topic)
Deprecated.
Unload a topic.
|
void |
Namespaces.unloadNamespaceBundle(String namespace,
String bundle)
Unload namespace bundle.
|
void |
Namespaces.unsubscribeNamespace(String namespace,
String subscription)
Unsubscribe the given subscription on all topics on a namespace.
|
void |
Namespaces.unsubscribeNamespaceBundle(String namespace,
String bundle,
String subscription)
Unsubscribe the given subscription on all topics on a namespace bundle.
|
void |
Bookies.updateBookieRackInfo(String bookieAddress,
String group,
BookieInfo bookieInfo)
Updates the rack placement information for a specific bookie in the cluster.
|
void |
Clusters.updateCluster(String cluster,
ClusterData clusterData)
Update the configuration for a cluster.
|
void |
Brokers.updateDynamicConfiguration(String configName,
String configValue)
Update a dynamic configuration value into ZooKeeper.
|
void |
Clusters.updateFailureDomain(String cluster,
String domainName,
FailureDomain domain)
Update a domain into cluster.
|
void |
Functions.updateFunction(FunctionConfig functionConfig,
String fileName)
Update the configuration for a function.
|
void |
Functions.updateFunction(FunctionConfig functionConfig,
String fileName,
UpdateOptions updateOptions)
Update the configuration for a function.
|
void |
Functions.updateFunctionWithUrl(FunctionConfig functionConfig,
String pkgUrl)
Update the configuration for a function.
|
void |
Functions.updateFunctionWithUrl(FunctionConfig functionConfig,
String pkgUrl,
UpdateOptions updateOptions)
Update the configuration for a function.
|
void |
Packages.updateMetadata(String packageName,
PackageMetadata metadata)
Update a package metadata information.
|
void |
Clusters.updateNamespaceIsolationPolicy(String cluster,
String policyName,
NamespaceIsolationData namespaceIsolationData)
Update a namespace isolation policy for a cluster.
|
void |
Topics.updatePartitionedTopic(String topic,
int numPartitions)
Update number of partitions of a non-global partitioned topic.
|
void |
Topics.updatePartitionedTopic(String topic,
int numPartitions,
boolean updateLocalTopicOnly)
Update number of partitions of a non-global partitioned topic.
|
void |
Clusters.updatePeerClusterNames(String cluster,
LinkedHashSet<String> peerClusterNames)
Update peer cluster names.
|
void |
Properties.updateProperty(String property,
TenantInfo config)
Deprecated.
Update the admins for a property.
|
void |
ResourceGroups.updateResourceGroup(String name,
ResourceGroup resourcegroup)
Update the configuration for a ResourceGroup.
|
void |
Sinks.updateSink(SinkConfig sinkConfig,
String fileName)
Update the configuration for a sink.
|
void |
Sinks.updateSink(SinkConfig sinkConfig,
String fileName,
UpdateOptions updateOptions)
Update the configuration for a sink.
|
void |
Sinks.updateSinkWithUrl(SinkConfig sinkConfig,
String pkgUrl)
Update the configuration for a sink.
|
void |
Sinks.updateSinkWithUrl(SinkConfig sinkConfig,
String pkgUrl,
UpdateOptions updateOptions)
Update the configuration for a sink.
|
void |
Sources.updateSource(SourceConfig sourceConfig,
String fileName)
Update the configuration for a source.
|
void |
Sources.updateSource(SourceConfig sourceConfig,
String fileName,
UpdateOptions updateOptions)
Update the configuration for a source.
|
void |
Sources.updateSourceWithUrl(SourceConfig sourceConfig,
String pkgUrl)
Update the configuration for a source.
|
void |
Sources.updateSourceWithUrl(SourceConfig sourceConfig,
String pkgUrl,
UpdateOptions updateOptions)
Update the configuration for a source.
|
void |
Tenants.updateTenant(String tenant,
TenantInfo config)
Update the admins for a tenant.
|
void |
Packages.upload(PackageMetadata metadata,
String packageName,
String path)
Upload a package to the package management service.
|
void |
Functions.uploadFunction(String sourceFile,
String path)
Upload Data.
|
Copyright © 2017–2021 Apache Software Foundation. All rights reserved.