Class QuotaBucket (2.55.0) 

public final class QuotaBucket extends GeneratedMessageV3 implements QuotaBucketOrBuilder

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

Protobuf type google.api.serviceusage.v1beta1.QuotaBucket

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > QuotaBucket

Static Fields

ADMIN_OVERRIDE_FIELD_NUMBER

public static final int ADMIN_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

CONSUMER_OVERRIDE_FIELD_NUMBER

public static final int CONSUMER_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

DEFAULT_LIMIT_FIELD_NUMBER

public static final int DEFAULT_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

EFFECTIVE_LIMIT_FIELD_NUMBER

public static final int EFFECTIVE_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

PRODUCER_OVERRIDE_FIELD_NUMBER

public static final int PRODUCER_OVERRIDE_FIELD_NUMBER
Field Value
Type Description
int

PRODUCER_QUOTA_POLICY_FIELD_NUMBER

public static final int PRODUCER_QUOTA_POLICY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QuotaBucket getDefaultInstance()
Returns
Type Description
QuotaBucket

getDescriptor()

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

newBuilder()

public static QuotaBucket.Builder newBuilder()
Returns
Type Description
QuotaBucket.Builder

newBuilder(QuotaBucket prototype)

public static QuotaBucket.Builder newBuilder(QuotaBucket prototype)
Parameter
Name Description
prototype QuotaBucket
Returns
Type Description
QuotaBucket.Builder

parseDelimitedFrom(InputStream input)

public static QuotaBucket parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QuotaBucket
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaBucket
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QuotaBucket parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QuotaBucket
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaBucket
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QuotaBucket parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QuotaBucket
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaBucket
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QuotaBucket parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QuotaBucket
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaBucket
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QuotaBucket parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QuotaBucket
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaBucket
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QuotaBucket parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QuotaBucket
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaBucket
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QuotaBucket> parser()
Returns
Type Description
Parser<QuotaBucket>

Methods

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

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdminOverride()

public QuotaOverride getAdminOverride()

Admin override on this quota bucket.

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

Returns
Type Description
QuotaOverride

The adminOverride.

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.

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.

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.

getParserForType()

public Parser<QuotaBucket> getParserForType()
Returns
Type Description
Parser<QuotaBucket>
Overrides

getProducerOverride()

public QuotaOverride getProducerOverride()

Producer override on this quota bucket.

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

Returns
Type Description
QuotaOverride

The producerOverride.

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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

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.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QuotaBucket.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QuotaBucket.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException