Package org.apache.pulsar.client.admin
Interface ResourceGroups
public interface ResourceGroups
Admin interface for ResourceGroups management.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
createResourceGroup
(String name, ResourceGroup resourcegroup) Create a new resourcegroup.createResourceGroupAsync
(String name, ResourceGroup resourcegroup) Create a new resourcegroup.void
deleteResourceGroup
(String resourcegroup) Delete an existing resourcegroup.deleteResourceGroupAsync
(String resourcegroup) Delete an existing resourcegroup.getResourceGroup
(String resourcegroup) Get configuration for a resourcegroup.getResourceGroupAsync
(String resourcegroup) Get policies for a namespace asynchronously.Get the list of resourcegroups.Get the list of resourcegroups asynchronously.void
updateResourceGroup
(String name, ResourceGroup resourcegroup) Update the configuration for a ResourceGroup.updateResourceGroupAsync
(String name, ResourceGroup resourcegroup) Update the configuration for a ResourceGroup.
-
Method Details
-
getResourceGroups
Get the list of resourcegroups. Get the list of all the resourcegroup. Response Example:["resourcegroup1", "resourcegroup2", "resourcegroup3"]
- Throws:
PulsarAdminException.NotAuthorizedException
- Don't have admin permissionPulsarAdminException
- Unexpected error
-
getResourceGroupsAsync
CompletableFuture<List<String>> getResourceGroupsAsync()Get the list of resourcegroups asynchronously. Get the list of all the resourcegrops. Response Example:["resourcegroup1", "resourcegroup2", "resourcegroup3"]
-
getResourceGroup
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 permissionPulsarAdminException.NotFoundException
- Resourcegroup does not existPulsarAdminException
- Unexpected error- See Also:
-
getResourceGroupAsync
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:
-
createResourceGroup
Create a new resourcegroup. Creates a new reourcegroup with the configuration specified.- Parameters:
name
- resourcegroup nameresourcegroup
- ResourceGroup configuration- Throws:
PulsarAdminException.NotAuthorizedException
- You don't have admin permissionPulsarAdminException.ConflictException
- Resourcegroup already existsPulsarAdminException
- Unexpected error
-
createResourceGroupAsync
Create a new resourcegroup. Creates a new resourcegroup with the configuration specified.- Parameters:
name
- resourcegroup nameresourcegroup
- ResourceGroup configuration.
-
updateResourceGroup
Update the configuration for a ResourceGroup. This operation requires Pulsar super-user privileges.- Parameters:
name
- resourcegroup nameresourcegroup
- resourcegroup configuration- Throws:
PulsarAdminException.NotAuthorizedException
- Don't have admin permissionPulsarAdminException.NotFoundException
- ResourceGroup does not existPulsarAdminException
- Unexpected error
-
updateResourceGroupAsync
Update the configuration for a ResourceGroup. This operation requires Pulsar super-user privileges.- Parameters:
name
- resourcegroup nameresourcegroup
- resourcegroup configuration
-
deleteResourceGroup
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 permissionPulsarAdminException.NotFoundException
- Resourcegroup does not existPulsarAdminException.ConflictException
- Resourcegroup is in usePulsarAdminException
- Unexpected error
-
deleteResourceGroupAsync
Delete an existing resourcegroup. The resourcegroup needs to unused and not attached to any entity.- Parameters:
resourcegroup
- Resourcegroup name
-