Package org.apache.pulsar.client.admin

Interface Tenants

public interface Tenants

Admin interface for tenants management.

Method Summary

Modifier and Type	Method	Description
void	createTenant(String tenant, TenantInfo config)	Create a new tenant.
CompletableFuture<Void>	createTenantAsync(String tenant, TenantInfo config)	Create a new tenant asynchronously.
void	deleteTenant(String tenant)	Delete an existing tenant.
void	deleteTenant(String tenant, boolean force)	Delete an existing tenant.
CompletableFuture<Void>	deleteTenantAsync(String tenant)	Delete an existing tenant asynchronously.
CompletableFuture<Void>	deleteTenantAsync(String tenant, boolean force)	Delete an existing tenant asynchronously.
TenantInfo	getTenantInfo(String tenant)	Get the config of the tenant.
CompletableFuture<TenantInfo>	getTenantInfoAsync(String tenant)	Get the config of the tenant asynchronously.
List<String>	getTenants()	Get the list of tenants.
CompletableFuture<List<String>>	getTenantsAsync()	Get the list of tenants asynchronously.
void	updateTenant(String tenant, TenantInfo config)	Update the admins for a tenant.
CompletableFuture<Void>	updateTenantAsync(String tenant, TenantInfo config)	Update the admins for a tenant asynchronously.

Method Details

getTenants

List<String> getTenants()
                 throws PulsarAdminException

Get the list of tenants.

Response Example:

 ["my-tenant", "other-tenant", "third-tenant"]
 

Returns:

the list of Pulsar tenants

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getTenantsAsync

CompletableFuture<List<String>> getTenantsAsync()

Get the list of tenants asynchronously.

Response Example:

 ["my-tenant", "other-tenant", "third-tenant"]
 

Returns:

the list of Pulsar tenants

getTenantInfo

TenantInfo getTenantInfo(String tenant)
                  throws PulsarAdminException

Get the config of the tenant.

Get the admin configuration for a given tenant.

Parameters:

tenant - Tenant name

Returns:

the tenant configuration

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Tenant does not exist

PulsarAdminException - Unexpected error

getTenantInfoAsync

CompletableFuture<TenantInfo> getTenantInfoAsync(String tenant)

Get the config of the tenant asynchronously.

Get the admin configuration for a given tenant.

Parameters:

tenant - Tenant name

Returns:

the tenant configuration

createTenant

void createTenant(String tenant,
 TenantInfo config)
           throws PulsarAdminException

Create a new tenant.

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

Parameters:

tenant - Tenant name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.ConflictException - Tenant already exists

PulsarAdminException.PreconditionFailedException - Tenant name is not valid

PulsarAdminException - Unexpected error

createTenantAsync

CompletableFuture<Void> createTenantAsync(String tenant,
 TenantInfo config)

Create a new tenant asynchronously.

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

Parameters:

tenant - Tenant name

config - Config data

updateTenant

void updateTenant(String tenant,
 TenantInfo config)
           throws PulsarAdminException

Update the admins for a tenant.

This operation requires Pulsar super-user privileges.

Parameters:

tenant - Tenant name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Tenant does not exist

PulsarAdminException - Unexpected error

updateTenantAsync

CompletableFuture<Void> updateTenantAsync(String tenant,
 TenantInfo config)

Update the admins for a tenant asynchronously.

This operation requires Pulsar super-user privileges.

Parameters:

tenant - Tenant name

config - Config data

deleteTenant

void deleteTenant(String tenant)
           throws PulsarAdminException

Delete an existing tenant.

Delete a tenant and all namespaces and topics under it.

Parameters:

tenant - Tenant name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - The tenant does not exist

PulsarAdminException.ConflictException - The tenant still has active namespaces

PulsarAdminException - Unexpected error

deleteTenant

void deleteTenant(String tenant,
 boolean force)
           throws PulsarAdminException

Delete an existing tenant.

Force flag delete a tenant forcefully and all namespaces and topics under it.

Parameters:

tenant - Tenant name

force - Delete tenant forcefully

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - The tenant does not exist

PulsarAdminException.ConflictException - The tenant still has active namespaces

PulsarAdminException - Unexpected error

deleteTenantAsync

CompletableFuture<Void> deleteTenantAsync(String tenant)

Delete an existing tenant asynchronously.

Delete a tenant and all namespaces and topics under it.

Parameters:

tenant - Tenant name

deleteTenantAsync

CompletableFuture<Void> deleteTenantAsync(String tenant,
 boolean force)

Delete an existing tenant asynchronously.

Force flag delete a tenant forcefully and all namespaces and topics under it.

Parameters:

tenant - Tenant name

force - Delete tenant forcefully