org.apache.pulsar.client.admin.internal

Class ResourceQuotasImpl

java.lang.Object

org.apache.pulsar.client.admin.internal.BaseResource

org.apache.pulsar.client.admin.internal.ResourceQuotasImpl

All Implemented Interfaces:

ResourceQuotas

public class ResourceQuotasImpl
extends BaseResource
implements ResourceQuotas

Constructor Summary

Constructors

Constructor and Description
ResourceQuotasImpl(javax.ws.rs.client.WebTarget web, Authentication auth)

Method Summary

Modifier and Type	Method and Description
ResourceQuota	getDefaultResourceQuota() Get default resource quota for new resource bundles.
ResourceQuota	getNamespaceBundleResourceQuota(String namespace, String bundle) Get resource quota of a namespace bundle.
void	resetNamespaceBundleResourceQuota(String namespace, String bundle) Reset resource quota for a namespace bundle to default value.
void	setDefaultResourceQuota(ResourceQuota quota) Set default resource quota for new namespace bundles.
void	setNamespaceBundleResourceQuota(String namespace, String bundle, ResourceQuota quota) Set resource quota for a namespace bundle.

Methods inherited from class org.apache.pulsar.client.admin.internal.BaseResource

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ResourceQuotasImpl

public ResourceQuotasImpl(javax.ws.rs.client.WebTarget web,
                          Authentication auth)

Method Detail

getDefaultResourceQuota

public ResourceQuota getDefaultResourceQuota()
                                      throws PulsarAdminException

Description copied from interface: ResourceQuotas

Get default resource quota for new resource bundles.

Get default resource quota for new resource bundles.

Response example:

 
  {
      "msgRateIn" : 10,
      "msgRateOut" : 30,
      "bandwidthIn" : 10000,
      "bandwidthOut" : 30000,
      "memory" : 100,
      "dynamic" : true
  }
 
 

Specified by:

getDefaultResourceQuota in interface ResourceQuotas

Throws:

PulsarAdminException.NotAuthorizedException - Permission denied

PulsarAdminException - Unexpected error

setDefaultResourceQuota

public void setDefaultResourceQuota(ResourceQuota quota)
                             throws PulsarAdminException

Description copied from interface: ResourceQuotas

Set default resource quota for new namespace bundles.

Set default resource quota for new namespace bundles.

The resource quota can be set with these properties:

• msgRateIn : The maximum incoming messages per second.
• msgRateOut : The maximum outgoing messages per second.
• bandwidthIn : The maximum inbound bandwidth used.
• bandwidthOut : The maximum outbound bandwidth used.
• memory : The maximum memory used.
• dynamic : allow the quota to be dynamically re-calculated.

Request parameter example:

 
  {
      "msgRateIn" : 10,
      "msgRateOut" : 30,
      "bandwidthIn" : 10000,
      "bandwidthOut" : 30000,
      "memory" : 100,
      "dynamic" : false
  }
 
 

Specified by:

setDefaultResourceQuota in interface ResourceQuotas

Parameters:

quota - The new ResourceQuota

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException - Unexpected error

getNamespaceBundleResourceQuota

public ResourceQuota getNamespaceBundleResourceQuota(String namespace,
                                                     String bundle)
                                              throws PulsarAdminException

Description copied from interface: ResourceQuotas

Get resource quota of a namespace bundle.

Get resource quota of a namespace bundle.

Response example:

 
  {
      "msgRateIn" : 10,
      "msgRateOut" : 30,
      "bandwidthIn" : 10000,
      "bandwidthOut" : 30000,
      "memory" : 100,
      "dynamic" : true
  }
 
 

Specified by:

getNamespaceBundleResourceQuota in interface ResourceQuotas

Parameters:

namespace - Namespace name

bundle - Range of bundle {start}_{end}

Throws:

PulsarAdminException.NotAuthorizedException - Permission denied

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

setNamespaceBundleResourceQuota

public void setNamespaceBundleResourceQuota(String namespace,
                                            String bundle,
                                            ResourceQuota quota)
                                     throws PulsarAdminException

Description copied from interface: ResourceQuotas

Set resource quota for a namespace bundle.

Set resource quota for a namespace bundle.

The resource quota can be set with these properties:

• msgRateIn : The maximum incoming messages per second.
• msgRateOut : The maximum outgoing messages per second.
• bandwidthIn : The maximum inbound bandwidth used.
• bandwidthOut : The maximum outbound bandwidth used.
• memory : The maximum memory used.
• dynamic : allow the quota to be dynamically re-calculated.

Request parameter example:

 
  {
      "msgRateIn" : 10,
      "msgRateOut" : 30,
      "bandwidthIn" : 10000,
      "bandwidthOut" : 30000,
      "memory" : 100,
      "dynamic" : false
  }
 
 

Specified by:

setNamespaceBundleResourceQuota in interface ResourceQuotas

Parameters:

namespace - Namespace name

bundle - Bundle range {start}_{end}

quota - The new ResourceQuota

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error

resetNamespaceBundleResourceQuota

public void resetNamespaceBundleResourceQuota(String namespace,
                                              String bundle)
                                       throws PulsarAdminException

Description copied from interface: ResourceQuotas

Reset resource quota for a namespace bundle to default value.

Reset resource quota for a namespace bundle to default value.

The resource quota policy will fall back to the default.

Specified by:

resetNamespaceBundleResourceQuota in interface ResourceQuotas

Parameters:

namespace - Namespace name

bundle - Bundle range {start}_{end}

Throws:

PulsarAdminException.NotAuthorizedException - Don't have admin permission

PulsarAdminException.NotFoundException - Namespace does not exist

PulsarAdminException - Unexpected error