org.apache.pulsar.client.admin

Interface Clusters

All Known Implementing Classes:

ClustersImpl

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.
void	createFailureDomain(String cluster, String domainName, FailureDomain domain) Create a domain into cluster
void	createNamespaceIsolationPolicy(String cluster, String policyName, NamespaceIsolationData namespaceIsolationData) Create a namespace isolation policy for a cluster
void	deleteCluster(String cluster) Delete an existing cluster
void	deleteFailureDomain(String cluster, String domainName) Delete a domain in cluster
void	deleteNamespaceIsolationPolicy(String cluster, String policyName) Delete a namespace isolation policy for a cluster
List<BrokerNamespaceIsolationData>	getBrokersWithNamespaceIsolationPolicy(String cluster) Returns list of active brokers with namespace-isolation policies attached to it.
BrokerNamespaceIsolationData	getBrokerWithNamespaceIsolationPolicy(String cluster, String broker) Returns active broker with namespace-isolation policies attached to it.
ClusterData	getCluster(String cluster) Get the configuration data for the specified cluster.
List<String>	getClusters() Get the list of clusters.
FailureDomain	getFailureDomain(String cluster, String domainName) Get the domain registered into a cluster
Map<String,FailureDomain>	getFailureDomains(String cluster) Get all registered domains in cluster
Map<String,NamespaceIsolationData>	getNamespaceIsolationPolicies(String cluster) Get the namespace isolation policies of a cluster
NamespaceIsolationData	getNamespaceIsolationPolicy(String cluster, String policyName) Get a single namespace isolation policy for a cluster
Set<String>	getPeerClusterNames(String cluster) Get peer-cluster names
void	updateCluster(String cluster, ClusterData clusterData) Update the configuration for a cluster.
void	updateFailureDomain(String cluster, String domainName, FailureDomain domain) Update a domain into cluster
void	updateNamespaceIsolationPolicy(String cluster, String policyName, NamespaceIsolationData namespaceIsolationData) Update a namespace isolation policy for a cluster
void	updatePeerClusterNames(String cluster, LinkedHashSet<String> peerClusterNames) Update peer cluster names.

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

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

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:

NotAuthorized - You don't have admin permission to create the cluster

PulsarAdminException.ConflictException - Cluster already exists

PulsarAdminException - Unexpected error

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

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

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

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

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

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

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

getBrokerWithNamespaceIsolationPolicy

BrokerNamespaceIsolationData getBrokerWithNamespaceIsolationPolicy(String cluster,
                                                                   String broker)
                                                            throws PulsarAdminException

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

Parameters:

cluster -

broker -

Returns:

Throws:

PulsarAdminException

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

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

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

createFailureDomain

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

Create a domain into cluster

Parameters:

cluster - Cluster name

domainName - domain name

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

updateFailureDomain

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

Update a domain into cluster

Parameters:

cluster - Cluster name

domainName - domain name

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

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

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

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