Package org.apache.pulsar.client.admin

Interface Clusters

public interface Clusters

Admin interface for clusters management.

Method Summary

Modifier and Type	Method	Description
void	createCluster(java.lang.String cluster, ClusterData clusterData)	Create a new cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	createClusterAsync(java.lang.String cluster, ClusterData clusterData)	Create a new cluster asynchronously.
void	createFailureDomain(java.lang.String cluster, java.lang.String domainName, FailureDomain domain)	Create a domain into cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	createFailureDomainAsync(java.lang.String cluster, java.lang.String domainName, FailureDomain domain)	Create a domain into cluster asynchronously.
void	createNamespaceIsolationPolicy(java.lang.String cluster, java.lang.String policyName, NamespaceIsolationData namespaceIsolationData)	Create a namespace isolation policy for a cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	createNamespaceIsolationPolicyAsync(java.lang.String cluster, java.lang.String policyName, NamespaceIsolationData namespaceIsolationData)	Create a namespace isolation policy for a cluster asynchronously.
void	deleteCluster(java.lang.String cluster)	Delete an existing cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteClusterAsync(java.lang.String cluster)	Delete an existing cluster asynchronously.
void	deleteFailureDomain(java.lang.String cluster, java.lang.String domainName)	Delete a domain in cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteFailureDomainAsync(java.lang.String cluster, java.lang.String domainName)	Delete a domain in cluster asynchronously.
void	deleteNamespaceIsolationPolicy(java.lang.String cluster, java.lang.String policyName)	Delete a namespace isolation policy for a cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteNamespaceIsolationPolicyAsync(java.lang.String cluster, java.lang.String policyName)	Delete a namespace isolation policy for a cluster asynchronously.
java.util.List<BrokerNamespaceIsolationData>	getBrokersWithNamespaceIsolationPolicy(java.lang.String cluster)	Returns list of active brokers with namespace-isolation policies attached to it.
java.util.concurrent.CompletableFuture<java.util.List<BrokerNamespaceIsolationData>>	getBrokersWithNamespaceIsolationPolicyAsync(java.lang.String cluster)	Returns list of active brokers with namespace-isolation policies attached to it asynchronously.
BrokerNamespaceIsolationData	getBrokerWithNamespaceIsolationPolicy(java.lang.String cluster, java.lang.String broker)	Returns active broker with namespace-isolation policies attached to it.
java.util.concurrent.CompletableFuture<BrokerNamespaceIsolationData>	getBrokerWithNamespaceIsolationPolicyAsync(java.lang.String cluster, java.lang.String broker)	Returns active broker with namespace-isolation policies attached to it asynchronously.
ClusterData	getCluster(java.lang.String cluster)	Get the configuration data for the specified cluster.
java.util.concurrent.CompletableFuture<ClusterData>	getClusterAsync(java.lang.String cluster)	Get the configuration data for the specified cluster asynchronously.
java.util.List<java.lang.String>	getClusters()	Get the list of clusters.
java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>>	getClustersAsync()	Get the list of clusters asynchronously.
FailureDomain	getFailureDomain(java.lang.String cluster, java.lang.String domainName)	Get the domain registered into a cluster.
java.util.concurrent.CompletableFuture<FailureDomain>	getFailureDomainAsync(java.lang.String cluster, java.lang.String domainName)	Get the domain registered into a cluster asynchronously.
java.util.Map<java.lang.String,FailureDomain>	getFailureDomains(java.lang.String cluster)	Get all registered domains in cluster.
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,FailureDomain>>	getFailureDomainsAsync(java.lang.String cluster)	Get all registered domains in cluster asynchronously.
java.util.Map<java.lang.String,NamespaceIsolationData>	getNamespaceIsolationPolicies(java.lang.String cluster)	Get the namespace isolation policies of a cluster.
java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,NamespaceIsolationData>>	getNamespaceIsolationPoliciesAsync(java.lang.String cluster)	Get the namespace isolation policies of a cluster asynchronously.
NamespaceIsolationData	getNamespaceIsolationPolicy(java.lang.String cluster, java.lang.String policyName)	Get a single namespace isolation policy for a cluster.
java.util.concurrent.CompletableFuture<NamespaceIsolationData>	getNamespaceIsolationPolicyAsync(java.lang.String cluster, java.lang.String policyName)	Get a single namespace isolation policy for a cluster asynchronously.
java.util.Set<java.lang.String>	getPeerClusterNames(java.lang.String cluster)	Get peer-cluster names.
java.util.concurrent.CompletableFuture<java.util.Set<java.lang.String>>	getPeerClusterNamesAsync(java.lang.String cluster)	Get peer-cluster names asynchronously.
void	updateCluster(java.lang.String cluster, ClusterData clusterData)	Update the configuration for a cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	updateClusterAsync(java.lang.String cluster, ClusterData clusterData)	Update the configuration for a cluster asynchronously.
void	updateFailureDomain(java.lang.String cluster, java.lang.String domainName, FailureDomain domain)	Update a domain into cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	updateFailureDomainAsync(java.lang.String cluster, java.lang.String domainName, FailureDomain domain)	Update a domain into cluster asynchronously.
void	updateNamespaceIsolationPolicy(java.lang.String cluster, java.lang.String policyName, NamespaceIsolationData namespaceIsolationData)	Update a namespace isolation policy for a cluster.
java.util.concurrent.CompletableFuture<java.lang.Void>	updateNamespaceIsolationPolicyAsync(java.lang.String cluster, java.lang.String policyName, NamespaceIsolationData namespaceIsolationData)	Update a namespace isolation policy for a cluster asynchronously.
void	updatePeerClusterNames(java.lang.String cluster, java.util.LinkedHashSet<java.lang.String> peerClusterNames)	Update peer cluster names.
java.util.concurrent.CompletableFuture<java.lang.Void>	updatePeerClusterNamesAsync(java.lang.String cluster, java.util.LinkedHashSet<java.lang.String> peerClusterNames)	Update peer cluster names asynchronously.

Method Detail

getClusters

java.util.List<java.lang.String> getClusters()
                                      throws PulsarAdminException

Get the list of clusters.

Get the list of all the Pulsar clusters.

Response Example:

 ["c1", "c2", "c3"]
 

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getClustersAsync

java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>> getClustersAsync()

Get the list of clusters asynchronously.

Get the list of all the Pulsar clusters.

Response Example:

 ["c1", "c2", "c3"]
 

getCluster

ClusterData getCluster(java.lang.String cluster)
                throws PulsarAdminException

Get the configuration data for the specified cluster.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Parameters:

cluster - Cluster name

Returns:

the cluster 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

getClusterAsync

java.util.concurrent.CompletableFuture<ClusterData> getClusterAsync(java.lang.String cluster)

Get the configuration data for the specified cluster asynchronously.

Response Example:

 { serviceUrl : "http://my-broker.example.com:8080/" }
 

Parameters:

cluster - Cluster name

Returns:

the cluster configuration

createCluster

void createCluster(java.lang.String cluster,
                   ClusterData clusterData)
            throws PulsarAdminException

Create a new cluster.

Provisions a new cluster. This operation requires Pulsar super-user privileges.

The name cannot contain '/' characters.

Parameters:

cluster - Cluster name

clusterData - the cluster configuration object

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.ConflictException - Cluster already exists

PulsarAdminException - Unexpected error

createClusterAsync

java.util.concurrent.CompletableFuture<java.lang.Void> createClusterAsync(java.lang.String cluster,
                                                                          ClusterData clusterData)

Create a new cluster asynchronously.

Provisions a new cluster. This operation requires Pulsar super-user privileges.

The name cannot contain '/' characters.

Parameters:

cluster - Cluster name

clusterData - the cluster configuration object

updateCluster

void updateCluster(java.lang.String cluster,
                   ClusterData clusterData)
            throws PulsarAdminException

Update the configuration for a cluster.

This operation requires Pulsar super-user privileges.

Parameters:

cluster - Cluster name

clusterData - the cluster configuration object

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateClusterAsync

java.util.concurrent.CompletableFuture<java.lang.Void> updateClusterAsync(java.lang.String cluster,
                                                                          ClusterData clusterData)

Update the configuration for a cluster asynchronously.

This operation requires Pulsar super-user privileges.

Parameters:

cluster - Cluster name

clusterData - the cluster configuration object

updatePeerClusterNames

void updatePeerClusterNames(java.lang.String cluster,
                            java.util.LinkedHashSet<java.lang.String> peerClusterNames)
                     throws PulsarAdminException

Update peer cluster names.

This operation requires Pulsar super-user privileges.

Parameters:

cluster - Cluster name

peerClusterNames - list of peer cluster names

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updatePeerClusterNamesAsync

java.util.concurrent.CompletableFuture<java.lang.Void> updatePeerClusterNamesAsync(java.lang.String cluster,
                                                                                   java.util.LinkedHashSet<java.lang.String> peerClusterNames)

Update peer cluster names asynchronously.

This operation requires Pulsar super-user privileges.

Parameters:

cluster - Cluster name

peerClusterNames - list of peer cluster names

getPeerClusterNames

java.util.Set<java.lang.String> getPeerClusterNames(java.lang.String cluster)
                                             throws PulsarAdminException

Get peer-cluster names.

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Domain doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getPeerClusterNamesAsync

java.util.concurrent.CompletableFuture<java.util.Set<java.lang.String>> getPeerClusterNamesAsync(java.lang.String cluster)

Get peer-cluster names asynchronously.

Parameters:

cluster - Cluster name

Returns:

deleteCluster

void deleteCluster(java.lang.String cluster)
            throws PulsarAdminException

Delete an existing cluster.

Delete a cluster

Parameters:

cluster - Cluster 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

deleteClusterAsync

java.util.concurrent.CompletableFuture<java.lang.Void> deleteClusterAsync(java.lang.String cluster)

Delete an existing cluster asynchronously.

Delete a cluster

Parameters:

cluster - Cluster name

getNamespaceIsolationPolicies

java.util.Map<java.lang.String,NamespaceIsolationData> getNamespaceIsolationPolicies(java.lang.String cluster)
                                                                                    throws PulsarAdminException

Get the namespace isolation policies of a cluster.

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Policies don't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getNamespaceIsolationPoliciesAsync

java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,NamespaceIsolationData>> getNamespaceIsolationPoliciesAsync(java.lang.String cluster)

Get the namespace isolation policies of a cluster asynchronously.

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Policies don't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

createNamespaceIsolationPolicy

void createNamespaceIsolationPolicy(java.lang.String cluster,
                                    java.lang.String policyName,
                                    NamespaceIsolationData namespaceIsolationData)
                             throws PulsarAdminException

Create a namespace isolation policy for a cluster.

Parameters:

cluster - Cluster name

policyName - Policy name

namespaceIsolationData - Namespace isolation policy configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

createNamespaceIsolationPolicyAsync

java.util.concurrent.CompletableFuture<java.lang.Void> createNamespaceIsolationPolicyAsync(java.lang.String cluster,
                                                                                           java.lang.String policyName,
                                                                                           NamespaceIsolationData namespaceIsolationData)

Create a namespace isolation policy for a cluster asynchronously.

Parameters:

cluster - Cluster name

policyName - Policy name

namespaceIsolationData - Namespace isolation policy configuration

Returns:

getBrokersWithNamespaceIsolationPolicy

java.util.List<BrokerNamespaceIsolationData> getBrokersWithNamespaceIsolationPolicy(java.lang.String cluster)
                                                                             throws PulsarAdminException

Returns list of active brokers with namespace-isolation policies attached to it.

Parameters:

cluster -

Returns:

Throws:

PulsarAdminException

getBrokersWithNamespaceIsolationPolicyAsync

java.util.concurrent.CompletableFuture<java.util.List<BrokerNamespaceIsolationData>> getBrokersWithNamespaceIsolationPolicyAsync(java.lang.String cluster)

Returns list of active brokers with namespace-isolation policies attached to it asynchronously.

Parameters:

cluster -

Returns:

getBrokerWithNamespaceIsolationPolicy

BrokerNamespaceIsolationData getBrokerWithNamespaceIsolationPolicy(java.lang.String cluster,
                                                                   java.lang.String broker)
                                                            throws PulsarAdminException

Returns active broker with namespace-isolation policies attached to it.

Parameters:

cluster -

broker -

Returns:

Throws:

PulsarAdminException

getBrokerWithNamespaceIsolationPolicyAsync

java.util.concurrent.CompletableFuture<BrokerNamespaceIsolationData> getBrokerWithNamespaceIsolationPolicyAsync(java.lang.String cluster,
                                                                                                                java.lang.String broker)

Returns active broker with namespace-isolation policies attached to it asynchronously.

Parameters:

cluster -

broker -

Returns:

updateNamespaceIsolationPolicy

void updateNamespaceIsolationPolicy(java.lang.String cluster,
                                    java.lang.String policyName,
                                    NamespaceIsolationData namespaceIsolationData)
                             throws PulsarAdminException

Update a namespace isolation policy for a cluster.

Parameters:

cluster - Cluster name

policyName - Policy name

namespaceIsolationData - Namespace isolation policy configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateNamespaceIsolationPolicyAsync

java.util.concurrent.CompletableFuture<java.lang.Void> updateNamespaceIsolationPolicyAsync(java.lang.String cluster,
                                                                                           java.lang.String policyName,
                                                                                           NamespaceIsolationData namespaceIsolationData)

Update a namespace isolation policy for a cluster asynchronously.

Parameters:

cluster - Cluster name

policyName - Policy name

namespaceIsolationData - Namespace isolation policy configuration

Returns:

deleteNamespaceIsolationPolicy

void deleteNamespaceIsolationPolicy(java.lang.String cluster,
                                    java.lang.String policyName)
                             throws PulsarAdminException

Delete a namespace isolation policy for a cluster.

Parameters:

cluster - Cluster name

policyName - Policy name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

deleteNamespaceIsolationPolicyAsync

java.util.concurrent.CompletableFuture<java.lang.Void> deleteNamespaceIsolationPolicyAsync(java.lang.String cluster,
                                                                                           java.lang.String policyName)

Delete a namespace isolation policy for a cluster asynchronously.

Parameters:

cluster - Cluster name

policyName - Policy name

Returns:

getNamespaceIsolationPolicy

NamespaceIsolationData getNamespaceIsolationPolicy(java.lang.String cluster,
                                                   java.lang.String policyName)
                                            throws PulsarAdminException

Get a single namespace isolation policy for a cluster.

Parameters:

cluster - Cluster name

policyName - Policy name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Policy doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getNamespaceIsolationPolicyAsync

java.util.concurrent.CompletableFuture<NamespaceIsolationData> getNamespaceIsolationPolicyAsync(java.lang.String cluster,
                                                                                                java.lang.String policyName)

Get a single namespace isolation policy for a cluster asynchronously.

Parameters:

cluster - Cluster name

policyName - Policy name

createFailureDomain

void createFailureDomain(java.lang.String cluster,
                         java.lang.String domainName,
                         FailureDomain domain)
                  throws PulsarAdminException

Create a domain into cluster.

Parameters:

cluster - Cluster name

domainName - domain name

domain - Domain configurations

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.ConflictException - Broker already exist into other domain

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

createFailureDomainAsync

java.util.concurrent.CompletableFuture<java.lang.Void> createFailureDomainAsync(java.lang.String cluster,
                                                                                java.lang.String domainName,
                                                                                FailureDomain domain)

Create a domain into cluster asynchronously.

Parameters:

cluster - Cluster name

domainName - domain name

domain - Domain configurations

Returns:

updateFailureDomain

void updateFailureDomain(java.lang.String cluster,
                         java.lang.String domainName,
                         FailureDomain domain)
                  throws PulsarAdminException

Update a domain into cluster.

Parameters:

cluster - Cluster name

domainName - domain name

domain - Domain configurations

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.ConflictException - Broker already exist into other domain

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

updateFailureDomainAsync

java.util.concurrent.CompletableFuture<java.lang.Void> updateFailureDomainAsync(java.lang.String cluster,
                                                                                java.lang.String domainName,
                                                                                FailureDomain domain)

Update a domain into cluster asynchronously.

Parameters:

cluster - Cluster name

domainName - domain name

domain - Domain configurations

Returns:

deleteFailureDomain

void deleteFailureDomain(java.lang.String cluster,
                         java.lang.String domainName)
                  throws PulsarAdminException

Delete a domain in cluster.

Parameters:

cluster - Cluster name

domainName - Domain name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

deleteFailureDomainAsync

java.util.concurrent.CompletableFuture<java.lang.Void> deleteFailureDomainAsync(java.lang.String cluster,
                                                                                java.lang.String domainName)

Delete a domain in cluster asynchronously.

Parameters:

cluster - Cluster name

domainName - Domain name

Returns:

getFailureDomains

java.util.Map<java.lang.String,FailureDomain> getFailureDomains(java.lang.String cluster)
                                                               throws PulsarAdminException

Get all registered domains in cluster.

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Cluster don't exist

PulsarAdminException - Unexpected error

getFailureDomainsAsync

java.util.concurrent.CompletableFuture<java.util.Map<java.lang.String,FailureDomain>> getFailureDomainsAsync(java.lang.String cluster)

Get all registered domains in cluster asynchronously.

Parameters:

cluster - Cluster name

Returns:

getFailureDomain

FailureDomain getFailureDomain(java.lang.String cluster,
                               java.lang.String domainName)
                        throws PulsarAdminException

Get the domain registered into a cluster.

Parameters:

cluster - Cluster name

Returns:

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission to create the cluster

PulsarAdminException.NotFoundException - Domain doesn't exist

PulsarAdminException.PreconditionFailedException - Cluster doesn't exist

PulsarAdminException - Unexpected error

getFailureDomainAsync

java.util.concurrent.CompletableFuture<FailureDomain> getFailureDomainAsync(java.lang.String cluster,
                                                                            java.lang.String domainName)

Get the domain registered into a cluster asynchronously.

Parameters:

cluster - Cluster name

Returns: