org.apache.pulsar.client.admin

Interface Clusters

public interface Clusters

Admin interface for clusters management.

Method Summary

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

Method Detail

getClusters

List<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

CompletableFuture<List<String>> getClustersAsync()

Get the list of clusters asynchronously.

Get the list of all the Pulsar clusters.

Response Example:

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

getCluster

ClusterData getCluster(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

CompletableFuture<ClusterData> getClusterAsync(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(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

CompletableFuture<Void> createClusterAsync(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(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

CompletableFuture<Void> updateClusterAsync(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(String cluster,
                            LinkedHashSet<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

CompletableFuture<Void> updatePeerClusterNamesAsync(String cluster,
                                                    LinkedHashSet<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

Set<String> getPeerClusterNames(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

CompletableFuture<Set<String>> getPeerClusterNamesAsync(String cluster)

Get peer-cluster names asynchronously.

Parameters:

cluster - Cluster name

Returns:

deleteCluster

void deleteCluster(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

CompletableFuture<Void> deleteClusterAsync(String cluster)

Delete an existing cluster asynchronously.

Delete a cluster

Parameters:

cluster - Cluster name

getNamespaceIsolationPolicies

Map<String,NamespaceIsolationData> getNamespaceIsolationPolicies(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

CompletableFuture<Map<String,NamespaceIsolationData>> getNamespaceIsolationPoliciesAsync(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(String cluster,
                                    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

CompletableFuture<Void> createNamespaceIsolationPolicyAsync(String cluster,
                                                            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

List<BrokerNamespaceIsolationData> getBrokersWithNamespaceIsolationPolicy(String cluster)
                                                                   throws PulsarAdminException

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

Parameters:

cluster -

Returns:

Throws:

PulsarAdminException

getBrokersWithNamespaceIsolationPolicyAsync

CompletableFuture<List<BrokerNamespaceIsolationData>> getBrokersWithNamespaceIsolationPolicyAsync(String cluster)

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

Parameters:

cluster -

Returns:

getBrokerWithNamespaceIsolationPolicy

BrokerNamespaceIsolationData getBrokerWithNamespaceIsolationPolicy(String cluster,
                                                                   String broker)
                                                            throws PulsarAdminException

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

Parameters:

cluster -

broker - the broker name in the form host:port.

Returns:

Throws:

PulsarAdminException

getBrokerWithNamespaceIsolationPolicyAsync

CompletableFuture<BrokerNamespaceIsolationData> getBrokerWithNamespaceIsolationPolicyAsync(String cluster,
                                                                                           String broker)

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

Parameters:

cluster -

broker -

Returns:

updateNamespaceIsolationPolicy

void updateNamespaceIsolationPolicy(String cluster,
                                    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

CompletableFuture<Void> updateNamespaceIsolationPolicyAsync(String cluster,
                                                            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(String cluster,
                                    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

CompletableFuture<Void> deleteNamespaceIsolationPolicyAsync(String cluster,
                                                            String policyName)

Delete a namespace isolation policy for a cluster asynchronously.

Parameters:

cluster - Cluster name

policyName - Policy name

Returns:

getNamespaceIsolationPolicy

NamespaceIsolationData getNamespaceIsolationPolicy(String cluster,
                                                   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

CompletableFuture<NamespaceIsolationData> getNamespaceIsolationPolicyAsync(String cluster,
                                                                           String policyName)

Get a single namespace isolation policy for a cluster asynchronously.

Parameters:

cluster - Cluster name

policyName - Policy name

createFailureDomain

void createFailureDomain(String cluster,
                         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

CompletableFuture<Void> createFailureDomainAsync(String cluster,
                                                 String domainName,
                                                 FailureDomain domain)

Create a domain into cluster asynchronously.

Parameters:

cluster - Cluster name

domainName - domain name

domain - Domain configurations

Returns:

updateFailureDomain

void updateFailureDomain(String cluster,
                         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

CompletableFuture<Void> updateFailureDomainAsync(String cluster,
                                                 String domainName,
                                                 FailureDomain domain)

Update a domain into cluster asynchronously.

Parameters:

cluster - Cluster name

domainName - domain name

domain - Domain configurations

Returns:

deleteFailureDomain

void deleteFailureDomain(String cluster,
                         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

CompletableFuture<Void> deleteFailureDomainAsync(String cluster,
                                                 String domainName)

Delete a domain in cluster asynchronously.

Parameters:

cluster - Cluster name

domainName - Domain name

Returns:

getFailureDomains

Map<String,FailureDomain> getFailureDomains(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

CompletableFuture<Map<String,FailureDomain>> getFailureDomainsAsync(String cluster)

Get all registered domains in cluster asynchronously.

Parameters:

cluster - Cluster name

Returns:

getFailureDomain

FailureDomain getFailureDomain(String cluster,
                               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

CompletableFuture<FailureDomain> getFailureDomainAsync(String cluster,
                                                       String domainName)

Get the domain registered into a cluster asynchronously.

Parameters:

cluster - Cluster name

Returns: