Package org.apache.pulsar.client.admin

Interface ResourceGroups

public interface ResourceGroups

Admin interface for ResourceGroups management.

Method Summary

Modifier and Type	Method	Description
void	createResourceGroup(java.lang.String name, ResourceGroup resourcegroup)	Create a new resourcegroup.
java.util.concurrent.CompletableFuture<java.lang.Void>	createResourceGroupAsync(java.lang.String name, ResourceGroup resourcegroup)	Create a new resourcegroup.
void	deleteResourceGroup(java.lang.String resourcegroup)	Delete an existing resourcegroup.
java.util.concurrent.CompletableFuture<java.lang.Void>	deleteResourceGroupAsync(java.lang.String resourcegroup)	Delete an existing resourcegroup.
ResourceGroup	getResourceGroup(java.lang.String resourcegroup)	Get configuration for a resourcegroup.
java.util.concurrent.CompletableFuture<ResourceGroup>	getResourceGroupAsync(java.lang.String resourcegroup)	Get policies for a namespace asynchronously.
java.util.List<java.lang.String>	getResourceGroups()	Get the list of resourcegroups.
java.util.concurrent.CompletableFuture<java.util.List<java.lang.String>>	getResourceGroupsAsync()	Get the list of resourcegroups asynchronously.
void	updateResourceGroup(java.lang.String name, ResourceGroup resourcegroup)	Update the configuration for a ResourceGroup.
java.util.concurrent.CompletableFuture<java.lang.Void>	updateResourceGroupAsync(java.lang.String name, ResourceGroup resourcegroup)	Update the configuration for a ResourceGroup.

Method Detail

getResourceGroups

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

Get the list of resourcegroups.

Get the list of all the resourcegroup.

Response Example:

 ["resourcegroup1",
  "resourcegroup2",
  "resourcegroup3"]
 

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getResourceGroupsAsync

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

Get the list of resourcegroups asynchronously.

Get the list of all the resourcegrops.

Response Example:

 ["resourcegroup1",
  "resourcegroup2",
  "resourcegroup3"]
 

getResourceGroup

ResourceGroup getResourceGroup(java.lang.String resourcegroup)
                        throws PulsarAdminException

Get configuration for a resourcegroup.

Get configuration specified for a resourcegroup.

Response Example:

 
     "publishRateInMsgs" : "value",
     "PublishRateInBytes" : "value",
     "DispatchRateInMsgs" : "value",
     "DispatchRateInBytes" : "value"
 
 

Parameters:

resourcegroup - String resourcegroup

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Resourcegroup does not exist

PulsarAdminException - Unexpected error

See Also:

*

getResourceGroupAsync

java.util.concurrent.CompletableFuture<ResourceGroup> getResourceGroupAsync(java.lang.String resourcegroup)

Get policies for a namespace asynchronously.

Get cnfiguration specified for a resourcegroup.

Response example:

 
     "publishRateInMsgs" : "value",
     "PublishRateInBytes" : "value",
     "DispatchRateInMsgs" : "value",
     "DspatchRateInBytes" : "value"
 
 

Parameters:

resourcegroup - Namespace name

See Also:

ResourceGroup

createResourceGroup

void createResourceGroup(java.lang.String name,
                         ResourceGroup resourcegroup)
                  throws PulsarAdminException

Create a new resourcegroup.

Creates a new reourcegroup with the configuration specified.

Parameters:

name - resourcegroup name

resourcegroup - ResourceGroup configuration

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.ConflictException - Resourcegroup already exists

PulsarAdminException - Unexpected error

createResourceGroupAsync

java.util.concurrent.CompletableFuture<java.lang.Void> createResourceGroupAsync(java.lang.String name,
                                                                                ResourceGroup resourcegroup)

Create a new resourcegroup.

Creates a new resourcegroup with the configuration specified.

Parameters:

name - resourcegroup name

resourcegroup - ResourceGroup configuration.

updateResourceGroup

void updateResourceGroup(java.lang.String name,
                         ResourceGroup resourcegroup)
                  throws PulsarAdminException

Update the configuration for a ResourceGroup.

This operation requires Pulsar super-user privileges.

Parameters:

name - resourcegroup name

resourcegroup - resourcegroup configuration

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - ResourceGroup does not exist

PulsarAdminException - Unexpected error

updateResourceGroupAsync

java.util.concurrent.CompletableFuture<java.lang.Void> updateResourceGroupAsync(java.lang.String name,
                                                                                ResourceGroup resourcegroup)

Update the configuration for a ResourceGroup.

This operation requires Pulsar super-user privileges.

Parameters:

name - resourcegroup name

resourcegroup - resourcegroup configuration

deleteResourceGroup

void deleteResourceGroup(java.lang.String resourcegroup)
                  throws PulsarAdminException

Delete an existing resourcegroup.

The resourcegroup needs to unused and not attached to any entity.

Parameters:

resourcegroup - Resourcegroup name

Throws:

PulsarAdminException.NotAuthorizedException - You don't have admin permission

PulsarAdminException.NotFoundException - Resourcegroup does not exist

PulsarAdminException.ConflictException - Resourcegroup is in use

PulsarAdminException - Unexpected error

deleteResourceGroupAsync

java.util.concurrent.CompletableFuture<java.lang.Void> deleteResourceGroupAsync(java.lang.String resourcegroup)

Delete an existing resourcegroup.

The resourcegroup needs to unused and not attached to any entity.

Parameters:

resourcegroup - Resourcegroup name