Class QuotaBucket.Builder (2.54.0)

public static final class QuotaBucket.Builder extends GeneratedMessageV3.Builder<QuotaBucket.Builder> implements QuotaBucketOrBuilder

A quota bucket is a quota provisioning unit for a specific set of dimensions.

Protobuf type google.api.serviceusage.v1beta1.QuotaBucket

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QuotaBucket.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QuotaBucket.Builder
Overrides

build()

public QuotaBucket build()
Returns
Type Description
QuotaBucket

buildPartial()

public QuotaBucket buildPartial()
Returns
Type Description
QuotaBucket

clear()

public QuotaBucket.Builder clear()
Returns
Type Description
QuotaBucket.Builder
Overrides

clearAdminOverride()

public QuotaBucket.Builder clearAdminOverride()

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Returns
Type Description
QuotaBucket.Builder

clearConsumerOverride()

public QuotaBucket.Builder clearConsumerOverride()

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Returns
Type Description
QuotaBucket.Builder

clearDefaultLimit()

public QuotaBucket.Builder clearDefaultLimit()

The default limit of this quota bucket, as specified by the service configuration.

int64 default_limit = 2;

Returns
Type Description
QuotaBucket.Builder

This builder for chaining.

clearDimensions()

public QuotaBucket.Builder clearDimensions()
Returns
Type Description
QuotaBucket.Builder

clearEffectiveLimit()

public QuotaBucket.Builder clearEffectiveLimit()

The effective limit of this quota bucket. Equal to default_limit if there are no overrides.

int64 effective_limit = 1;

Returns
Type Description
QuotaBucket.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public QuotaBucket.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
QuotaBucket.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public QuotaBucket.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
QuotaBucket.Builder
Overrides

clearProducerOverride()

public QuotaBucket.Builder clearProducerOverride()

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Returns
Type Description
QuotaBucket.Builder

clearProducerQuotaPolicy()

public QuotaBucket.Builder clearProducerQuotaPolicy()

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Returns
Type Description
QuotaBucket.Builder

clone()

public QuotaBucket.Builder clone()
Returns
Type Description
QuotaBucket.Builder
Overrides

containsDimensions(String key)

public boolean containsDimensions(String key)

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Parameter
Name Description
key String
Returns
Type Description
boolean

getAdminOverride()

public QuotaOverride getAdminOverride()

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Returns
Type Description
QuotaOverride

The adminOverride.

getAdminOverrideBuilder()

public QuotaOverride.Builder getAdminOverrideBuilder()

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Returns
Type Description
QuotaOverride.Builder

getAdminOverrideOrBuilder()

public QuotaOverrideOrBuilder getAdminOverrideOrBuilder()

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Returns
Type Description
QuotaOverrideOrBuilder

getConsumerOverride()

public QuotaOverride getConsumerOverride()

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Returns
Type Description
QuotaOverride

The consumerOverride.

getConsumerOverrideBuilder()

public QuotaOverride.Builder getConsumerOverrideBuilder()

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Returns
Type Description
QuotaOverride.Builder

getConsumerOverrideOrBuilder()

public QuotaOverrideOrBuilder getConsumerOverrideOrBuilder()

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Returns
Type Description
QuotaOverrideOrBuilder

getDefaultInstanceForType()

public QuotaBucket getDefaultInstanceForType()
Returns
Type Description
QuotaBucket

getDefaultLimit()

public long getDefaultLimit()

The default limit of this quota bucket, as specified by the service configuration.

int64 default_limit = 2;

Returns
Type Description
long

The defaultLimit.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDimensions() (deprecated)

public Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
Type Description
Map<String,String>

getDimensionsCount()

public int getDimensionsCount()

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Returns
Type Description
int

getDimensionsMap()

public Map<String,String> getDimensionsMap()

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Returns
Type Description
Map<String,String>

getDimensionsOrDefault(String key, String defaultValue)

public String getDimensionsOrDefault(String key, String defaultValue)

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getDimensionsOrThrow(String key)

public String getDimensionsOrThrow(String key)

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Parameter
Name Description
key String
Returns
Type Description
String

getEffectiveLimit()

public long getEffectiveLimit()

The effective limit of this quota bucket. Equal to default_limit if there are no overrides.

int64 effective_limit = 1;

Returns
Type Description
long

The effectiveLimit.

getMutableDimensions() (deprecated)

public Map<String,String> getMutableDimensions()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getProducerOverride()

public QuotaOverride getProducerOverride()

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Returns
Type Description
QuotaOverride

The producerOverride.

getProducerOverrideBuilder()

public QuotaOverride.Builder getProducerOverrideBuilder()

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Returns
Type Description
QuotaOverride.Builder

getProducerOverrideOrBuilder()

public QuotaOverrideOrBuilder getProducerOverrideOrBuilder()

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Returns
Type Description
QuotaOverrideOrBuilder

getProducerQuotaPolicy()

public ProducerQuotaPolicy getProducerQuotaPolicy()

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Returns
Type Description
ProducerQuotaPolicy

The producerQuotaPolicy.

getProducerQuotaPolicyBuilder()

public ProducerQuotaPolicy.Builder getProducerQuotaPolicyBuilder()

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Returns
Type Description
ProducerQuotaPolicy.Builder

getProducerQuotaPolicyOrBuilder()

public ProducerQuotaPolicyOrBuilder getProducerQuotaPolicyOrBuilder()

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Returns
Type Description
ProducerQuotaPolicyOrBuilder

hasAdminOverride()

public boolean hasAdminOverride()

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Returns
Type Description
boolean

Whether the adminOverride field is set.

hasConsumerOverride()

public boolean hasConsumerOverride()

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Returns
Type Description
boolean

Whether the consumerOverride field is set.

hasProducerOverride()

public boolean hasProducerOverride()

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Returns
Type Description
boolean

Whether the producerOverride field is set.

hasProducerQuotaPolicy()

public boolean hasProducerQuotaPolicy()

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Returns
Type Description
boolean

Whether the producerQuotaPolicy field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMutableMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAdminOverride(QuotaOverride value)

public QuotaBucket.Builder mergeAdminOverride(QuotaOverride value)

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Parameter
Name Description
value QuotaOverride
Returns
Type Description
QuotaBucket.Builder

mergeConsumerOverride(QuotaOverride value)

public QuotaBucket.Builder mergeConsumerOverride(QuotaOverride value)

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Parameter
Name Description
value QuotaOverride
Returns
Type Description
QuotaBucket.Builder

mergeFrom(QuotaBucket other)

public QuotaBucket.Builder mergeFrom(QuotaBucket other)
Parameter
Name Description
other QuotaBucket
Returns
Type Description
QuotaBucket.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QuotaBucket.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaBucket.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public QuotaBucket.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
QuotaBucket.Builder
Overrides

mergeProducerOverride(QuotaOverride value)

public QuotaBucket.Builder mergeProducerOverride(QuotaOverride value)

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Parameter
Name Description
value QuotaOverride
Returns
Type Description
QuotaBucket.Builder

mergeProducerQuotaPolicy(ProducerQuotaPolicy value)

public QuotaBucket.Builder mergeProducerQuotaPolicy(ProducerQuotaPolicy value)

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Parameter
Name Description
value ProducerQuotaPolicy
Returns
Type Description
QuotaBucket.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QuotaBucket.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QuotaBucket.Builder
Overrides

putAllDimensions(Map<String,String> values)

public QuotaBucket.Builder putAllDimensions(Map<String,String> values)

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Parameter
Name Description
values Map<String,String>
Returns
Type Description
QuotaBucket.Builder

putDimensions(String key, String value)

public QuotaBucket.Builder putDimensions(String key, String value)

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Parameters
Name Description
key String
value String
Returns
Type Description
QuotaBucket.Builder

removeDimensions(String key)

public QuotaBucket.Builder removeDimensions(String key)

The dimensions of this quota bucket.

If this map is empty, this is the global bucket, which is the default quota value applied to all requests that do not have a more specific override.

If this map is nonempty, the default limit, effective limit, and quota overrides apply only to requests that have the dimensions given in the map.

For example, if the map has key region and value us-east-1, then the specified effective limit is only effective in that region, and the specified overrides apply only in that region.

map<string, string> dimensions = 6;

Parameter
Name Description
key String
Returns
Type Description
QuotaBucket.Builder

setAdminOverride(QuotaOverride value)

public QuotaBucket.Builder setAdminOverride(QuotaOverride value)

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Parameter
Name Description
value QuotaOverride
Returns
Type Description
QuotaBucket.Builder

setAdminOverride(QuotaOverride.Builder builderForValue)

public QuotaBucket.Builder setAdminOverride(QuotaOverride.Builder builderForValue)

Admin override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride admin_override = 5;

Parameter
Name Description
builderForValue QuotaOverride.Builder
Returns
Type Description
QuotaBucket.Builder

setConsumerOverride(QuotaOverride value)

public QuotaBucket.Builder setConsumerOverride(QuotaOverride value)

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Parameter
Name Description
value QuotaOverride
Returns
Type Description
QuotaBucket.Builder

setConsumerOverride(QuotaOverride.Builder builderForValue)

public QuotaBucket.Builder setConsumerOverride(QuotaOverride.Builder builderForValue)

Consumer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride consumer_override = 4;

Parameter
Name Description
builderForValue QuotaOverride.Builder
Returns
Type Description
QuotaBucket.Builder

setDefaultLimit(long value)

public QuotaBucket.Builder setDefaultLimit(long value)

The default limit of this quota bucket, as specified by the service configuration.

int64 default_limit = 2;

Parameter
Name Description
value long

The defaultLimit to set.

Returns
Type Description
QuotaBucket.Builder

This builder for chaining.

setEffectiveLimit(long value)

public QuotaBucket.Builder setEffectiveLimit(long value)

The effective limit of this quota bucket. Equal to default_limit if there are no overrides.

int64 effective_limit = 1;

Parameter
Name Description
value long

The effectiveLimit to set.

Returns
Type Description
QuotaBucket.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public QuotaBucket.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
QuotaBucket.Builder
Overrides

setProducerOverride(QuotaOverride value)

public QuotaBucket.Builder setProducerOverride(QuotaOverride value)

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Parameter
Name Description
value QuotaOverride
Returns
Type Description
QuotaBucket.Builder

setProducerOverride(QuotaOverride.Builder builderForValue)

public QuotaBucket.Builder setProducerOverride(QuotaOverride.Builder builderForValue)

Producer override on this quota bucket.

.google.api.serviceusage.v1beta1.QuotaOverride producer_override = 3;

Parameter
Name Description
builderForValue QuotaOverride.Builder
Returns
Type Description
QuotaBucket.Builder

setProducerQuotaPolicy(ProducerQuotaPolicy value)

public QuotaBucket.Builder setProducerQuotaPolicy(ProducerQuotaPolicy value)

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Parameter
Name Description
value ProducerQuotaPolicy
Returns
Type Description
QuotaBucket.Builder

setProducerQuotaPolicy(ProducerQuotaPolicy.Builder builderForValue)

public QuotaBucket.Builder setProducerQuotaPolicy(ProducerQuotaPolicy.Builder builderForValue)

Producer policy inherited from the closet ancestor of the current consumer.

.google.api.serviceusage.v1beta1.ProducerQuotaPolicy producer_quota_policy = 7;

Parameter
Name Description
builderForValue ProducerQuotaPolicy.Builder
Returns
Type Description
QuotaBucket.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public QuotaBucket.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
QuotaBucket.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final QuotaBucket.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
QuotaBucket.Builder
Overrides