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

Field Summary

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

auth, readTimeoutMs

Constructor Summary

Constructors

Constructor and Description
ResourceQuotasImpl(javax.ws.rs.client.WebTarget web, org.apache.pulsar.client.api.Authentication auth, long readTimeoutMs)

Method Summary

Modifier and Type	Method and Description
org.apache.pulsar.common.policies.data.ResourceQuota	getDefaultResourceQuota() Get default resource quota for new resource bundles.
CompletableFuture<org.apache.pulsar.common.policies.data.ResourceQuota>	getDefaultResourceQuotaAsync() Get default resource quota for new resource bundles asynchronously.
org.apache.pulsar.common.policies.data.ResourceQuota	getNamespaceBundleResourceQuota(String namespace, String bundle) Get resource quota of a namespace bundle.
CompletableFuture<org.apache.pulsar.common.policies.data.ResourceQuota>	getNamespaceBundleResourceQuotaAsync(String namespace, String bundle) Get resource quota of a namespace bundle asynchronously.
void	resetNamespaceBundleResourceQuota(String namespace, String bundle) Reset resource quota for a namespace bundle to default value.
CompletableFuture<Void>	resetNamespaceBundleResourceQuotaAsync(String namespace, String bundle) Reset resource quota for a namespace bundle to default value asynchronously.
void	setDefaultResourceQuota(org.apache.pulsar.common.policies.data.ResourceQuota quota) Set default resource quota for new namespace bundles.
CompletableFuture<Void>	setDefaultResourceQuotaAsync(org.apache.pulsar.common.policies.data.ResourceQuota quota) Set default resource quota for new namespace bundles asynchronously.
void	setNamespaceBundleResourceQuota(String namespace, String bundle, org.apache.pulsar.common.policies.data.ResourceQuota quota) Set resource quota for a namespace bundle.
CompletableFuture<Void>	setNamespaceBundleResourceQuotaAsync(String namespace, String bundle, org.apache.pulsar.common.policies.data.ResourceQuota quota) Set resource quota for a namespace bundle asynchronously.

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

asyncDeleteRequest, asyncGetRequest, asyncPostRequest, asyncPutRequest, getApiException, getApiException, request, requestAsync

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,
                          org.apache.pulsar.client.api.Authentication auth,
                          long readTimeoutMs)

Method Detail

getDefaultResourceQuota

public org.apache.pulsar.common.policies.data.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

getDefaultResourceQuotaAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.ResourceQuota> getDefaultResourceQuotaAsync()

Description copied from interface: ResourceQuotas

Get default resource quota for new resource bundles asynchronously.

Get default resource quota for new resource bundles.

Response example:

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

Specified by:

getDefaultResourceQuotaAsync in interface ResourceQuotas

setDefaultResourceQuota

public void setDefaultResourceQuota(org.apache.pulsar.common.policies.data.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

setDefaultResourceQuotaAsync

public CompletableFuture<Void> setDefaultResourceQuotaAsync(org.apache.pulsar.common.policies.data.ResourceQuota quota)

Description copied from interface: ResourceQuotas

Set default resource quota for new namespace bundles asynchronously.

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:

setDefaultResourceQuotaAsync in interface ResourceQuotas

Parameters:

quota - The new ResourceQuota

getNamespaceBundleResourceQuota

public org.apache.pulsar.common.policies.data.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

getNamespaceBundleResourceQuotaAsync

public CompletableFuture<org.apache.pulsar.common.policies.data.ResourceQuota> getNamespaceBundleResourceQuotaAsync(String namespace,
                                                                                                                    String bundle)

Description copied from interface: ResourceQuotas

Get resource quota of a namespace bundle asynchronously.

Get resource quota of a namespace bundle.

Response example:

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

Specified by:

getNamespaceBundleResourceQuotaAsync in interface ResourceQuotas

Parameters:

namespace - Namespace name

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

setNamespaceBundleResourceQuota

public void setNamespaceBundleResourceQuota(String namespace,
                                            String bundle,
                                            org.apache.pulsar.common.policies.data.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

setNamespaceBundleResourceQuotaAsync

public CompletableFuture<Void> setNamespaceBundleResourceQuotaAsync(String namespace,
                                                                    String bundle,
                                                                    org.apache.pulsar.common.policies.data.ResourceQuota quota)

Description copied from interface: ResourceQuotas

Set resource quota for a namespace bundle asynchronously.

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:

setNamespaceBundleResourceQuotaAsync in interface ResourceQuotas

Parameters:

namespace - Namespace name

bundle - Bundle range {start}_{end}

quota - The new ResourceQuota

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

resetNamespaceBundleResourceQuotaAsync

public CompletableFuture<Void> resetNamespaceBundleResourceQuotaAsync(String namespace,
                                                                      String bundle)

Description copied from interface: ResourceQuotas

Reset resource quota for a namespace bundle to default value asynchronously.

Reset resource quota for a namespace bundle to default value.

The resource quota policy will fall back to the default.

Specified by:

resetNamespaceBundleResourceQuotaAsync in interface ResourceQuotas

Parameters:

namespace - Namespace name

bundle - Bundle range {start}_{end}