Class QuotaBucket (2.35.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

Static Fields

ADMIN_OVERRIDE_FIELD_NUMBER

public static final int ADMIN_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

CONSUMER_OVERRIDE_FIELD_NUMBER

public static final int CONSUMER_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

DEFAULT_LIMIT_FIELD_NUMBER

public static final int DEFAULT_LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

EFFECTIVE_LIMIT_FIELD_NUMBER

public static final int EFFECTIVE_LIMIT_FIELD_NUMBER
Field Value
TypeDescription
int

PRODUCER_OVERRIDE_FIELD_NUMBER

public static final int PRODUCER_OVERRIDE_FIELD_NUMBER
Field Value
TypeDescription
int

PRODUCER_QUOTA_POLICY_FIELD_NUMBER

public static final int PRODUCER_QUOTA_POLICY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static QuotaBucket getDefaultInstance()
Returns
TypeDescription
QuotaBucket

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static QuotaBucket.Builder newBuilder()
Returns
TypeDescription
QuotaBucket.Builder

newBuilder(QuotaBucket prototype)

public static QuotaBucket.Builder newBuilder(QuotaBucket prototype)
Parameter
NameDescription
prototypeQuotaBucket
Returns
TypeDescription
QuotaBucket.Builder

parseDelimitedFrom(InputStream input)

public static QuotaBucket parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static QuotaBucket parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QuotaBucket parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QuotaBucket parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static QuotaBucket parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static QuotaBucket parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QuotaBucket parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
QuotaBucket
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<QuotaBucket> parser()
Returns
TypeDescription
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
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getAdminOverride()

public QuotaOverride getAdminOverride()

Admin override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride

The adminOverride.

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.

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.

getDimensions() (deprecated)

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.

getParserForType()

public Parser<QuotaBucket> getParserForType()
Returns
TypeDescription
Parser<QuotaBucket>
Overrides

getProducerOverride()

public QuotaOverride getProducerOverride()

Producer override on this quota bucket.

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

Returns
TypeDescription
QuotaOverride

The producerOverride.