org.apache.pulsar.client.admin

Interface Properties

Deprecated.

see Tenants from PulsarAdmin.tenants()

@Deprecated
public interface Properties

Admin interface for properties management.

Method Summary

Modifier and Type	Method and Description
void	createProperty(String property, TenantInfo config) Deprecated. Create a new property.
void	deleteProperty(String property) Deprecated. Delete an existing property.
List<String>	getProperties() Deprecated. Get the list of properties.
TenantInfo	getPropertyAdmin(String property) Deprecated. Get the config of the property.
void	updateProperty(String property, TenantInfo config) Deprecated. Update the admins for a property.

Method Detail

getProperties

List<String> getProperties()
                    throws PulsarAdminException

Deprecated.

Get the list of properties.

Get the list of all the properties.

Response Example:

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

Returns:

the list of Pulsar tenants properties

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getPropertyAdmin

TenantInfo getPropertyAdmin(String property)
                     throws PulsarAdminException

Deprecated.

Get the config of the property.

Get the admin configuration for a given property.

Parameters:

property - Property name

Returns:

the property configuration

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Property does not exist

PulsarAdminException - Unexpected error

createProperty

void createProperty(String property,
                    TenantInfo config)
             throws PulsarAdminException

Deprecated.

Create a new property.

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

Parameters:

property - Property name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.ConflictException - Property already exists

PulsarAdminException.PreconditionFailedException - Property name is not valid

PulsarAdminException - Unexpected error

updateProperty

void updateProperty(String property,
                    TenantInfo config)
             throws PulsarAdminException

Deprecated.

Update the admins for a property.

This operation requires Pulsar super-user privileges.

Parameters:

property - Property name

config - Config data

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Property does not exist

PulsarAdminException - Unexpected error

deleteProperty

void deleteProperty(String property)
             throws PulsarAdminException

Deprecated.

Delete an existing property.

Delete a property and all namespaces and topics under it.

Parameters:

property - Property name

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - The property does not exist

PulsarAdminException.ConflictException - The property still has active namespaces

PulsarAdminException - Unexpected error