Class QuotaBucket.Builder (2.24.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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public QuotaBucket.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
QuotaBucket.Builder
Overrides

build()

public QuotaBucket build()
Returns
TypeDescription
QuotaBucket

buildPartial()

public QuotaBucket buildPartial()
Returns
TypeDescription
QuotaBucket

clear()

public QuotaBucket.Builder clear()
Returns
TypeDescription
QuotaBucket.Builder
Overrides

clearAdminOverride()

public QuotaBucket.Builder clearAdminOverride()

Admin override on this quota bucket.

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

Returns
TypeDescription
QuotaBucket.Builder

clearConsumerOverride()

public QuotaBucket.Builder clearConsumerOverride()

Consumer override on this quota bucket.

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

Returns
TypeDescription
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
TypeDescription
QuotaBucket.Builder

This builder for chaining.

clearDimensions()

public QuotaBucket.Builder clearDimensions()
Returns
TypeDescription
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
TypeDescription
QuotaBucket.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public QuotaBucket.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
QuotaBucket.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public QuotaBucket.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
QuotaBucket.Builder
Overrides

clearProducerOverride()

public QuotaBucket.Builder clearProducerOverride()

Producer override on this quota bucket.

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

Returns
TypeDescription
QuotaBucket.Builder

clone()

public QuotaBucket.Builder clone()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

getAdminOverride()

public QuotaOverride getAdminOverride()

Admin override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride

The adminOverride.

getAdminOverrideBuilder()

public QuotaOverride.Builder getAdminOverrideBuilder()

Admin override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride.Builder

getAdminOverrideOrBuilder()

public QuotaOverrideOrBuilder getAdminOverrideOrBuilder()

Admin override on this quota bucket.

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

Returns
TypeDescription
QuotaOverrideOrBuilder

getConsumerOverride()

public QuotaOverride getConsumerOverride()

Consumer override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride

The consumerOverride.

getConsumerOverrideBuilder()

public QuotaOverride.Builder getConsumerOverrideBuilder()

Consumer override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride.Builder

getConsumerOverrideOrBuilder()

public QuotaOverrideOrBuilder getConsumerOverrideOrBuilder()

Consumer override on this quota bucket.

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

Returns
TypeDescription
QuotaOverrideOrBuilder

getDefaultInstanceForType()

public QuotaBucket getDefaultInstanceForType()
Returns
TypeDescription
QuotaBucket

getDefaultLimit()

public long getDefaultLimit()

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

int64 default_limit = 2;

Returns
TypeDescription
long

The defaultLimit.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getDimensions()

public Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
NameDescription
keyString
defaultValueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
TypeDescription
long

The effectiveLimit.

getMutableDimensions()

public Map<String,String> getMutableDimensions()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

getProducerOverride()

public QuotaOverride getProducerOverride()

Producer override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride

The producerOverride.

getProducerOverrideBuilder()

public QuotaOverride.Builder getProducerOverrideBuilder()

Producer override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride.Builder

getProducerOverrideOrBuilder()

public QuotaOverrideOrBuilder getProducerOverrideOrBuilder()

Producer override on this quota bucket.

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

Returns
TypeDescription
QuotaOverrideOrBuilder

hasAdminOverride()

public boolean hasAdminOverride()

Admin override on this quota bucket.

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

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the producerOverride field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

internalGetMutableMapField(int number)

protected MapField internalGetMutableMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
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
NameDescription
valueQuotaOverride
Returns
TypeDescription
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
NameDescription
valueQuotaOverride
Returns
TypeDescription
QuotaBucket.Builder

mergeFrom(QuotaBucket other)

public QuotaBucket.Builder mergeFrom(QuotaBucket other)
Parameter
NameDescription
otherQuotaBucket
Returns
TypeDescription
QuotaBucket.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public QuotaBucket.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaBucket.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public QuotaBucket.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueQuotaOverride
Returns
TypeDescription
QuotaBucket.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final QuotaBucket.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
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
NameDescription
valuesMap<String,String>
Returns
TypeDescription
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
NameDescription
keyString
valueString
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
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
NameDescription
valueQuotaOverride
Returns
TypeDescription
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
NameDescription
builderForValueQuotaOverride.Builder
Returns
TypeDescription
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
NameDescription
valueQuotaOverride
Returns
TypeDescription
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
NameDescription
builderForValueQuotaOverride.Builder
Returns
TypeDescription
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
NameDescription
valuelong

The defaultLimit to set.

Returns
TypeDescription
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
NameDescription
valuelong

The effectiveLimit to set.

Returns
TypeDescription
QuotaBucket.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public QuotaBucket.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueQuotaOverride
Returns
TypeDescription
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
NameDescription
builderForValueQuotaOverride.Builder
Returns
TypeDescription
QuotaBucket.Builder

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

public QuotaBucket.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
QuotaBucket.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final QuotaBucket.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
QuotaBucket.Builder
Overrides