Class QuotaOverride (2.39.0)

publicfinalclass QuotaOverrideextendsGeneratedMessageV3implementsQuotaOverrideOrBuilder

A quota override

Protobuf type google.api.serviceusage.v1beta1.QuotaOverride

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

ADMIN_OVERRIDE_ANCESTOR_FIELD_NUMBER

publicstaticfinalintADMIN_OVERRIDE_ANCESTOR_FIELD_NUMBER
Field Value
Type Description
int

DIMENSIONS_FIELD_NUMBER

publicstaticfinalintDIMENSIONS_FIELD_NUMBER
Field Value
Type Description
int

METRIC_FIELD_NUMBER

publicstaticfinalintMETRIC_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

publicstaticfinalintNAME_FIELD_NUMBER
Field Value
Type Description
int

OVERRIDE_VALUE_FIELD_NUMBER

publicstaticfinalintOVERRIDE_VALUE_FIELD_NUMBER
Field Value
Type Description
int

UNIT_FIELD_NUMBER

publicstaticfinalintUNIT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticQuotaOverridegetDefaultInstance()
Returns
Type Description
QuotaOverride

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticQuotaOverride.BuildernewBuilder()
Returns
Type Description
QuotaOverride.Builder

newBuilder(QuotaOverride prototype)

publicstaticQuotaOverride.BuildernewBuilder(QuotaOverrideprototype)
Parameter
Name Description
prototype QuotaOverride
Returns
Type Description
QuotaOverride.Builder

parseDelimitedFrom(InputStream input)

publicstaticQuotaOverrideparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
QuotaOverride
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQuotaOverrideparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaOverride
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticQuotaOverrideparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
QuotaOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticQuotaOverrideparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticQuotaOverrideparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
QuotaOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticQuotaOverrideparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticQuotaOverrideparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QuotaOverride
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQuotaOverrideparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaOverride
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticQuotaOverrideparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
QuotaOverride
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQuotaOverrideparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaOverride
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticQuotaOverrideparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QuotaOverride
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticQuotaOverrideparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QuotaOverride
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<QuotaOverride>parser()
Returns
Type Description
Parser<QuotaOverride>

Methods

containsDimensions(String key)

publicbooleancontainsDimensions(Stringkey)

If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.

For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the override is only applied to quota consumed in that region.

This map has the following restrictions:

  • Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
  • project is not a valid key; the project is already specified in the parent resource name.
  • user is not a valid key; the API does not support quota overrides that apply only to a specific user.
  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • If any valid key other than region or zone appears in the map, then all valid keys other than region or zone must also appear in the map.

map<string, string> dimensions = 3;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAdminOverrideAncestor()

publicStringgetAdminOverrideAncestor()

The resource name of the ancestor that requested the override. For example: organizations/12345 or folders/67890. Used by admin overrides only.

string admin_override_ancestor = 6;

Returns
Type Description
String

The adminOverrideAncestor.

getAdminOverrideAncestorBytes()

publicByteStringgetAdminOverrideAncestorBytes()

The resource name of the ancestor that requested the override. For example: organizations/12345 or folders/67890. Used by admin overrides only.

string admin_override_ancestor = 6;

Returns
Type Description
ByteString

The bytes for adminOverrideAncestor.

getDefaultInstanceForType()

publicQuotaOverridegetDefaultInstanceForType()
Returns
Type Description
QuotaOverride

getDimensions() (deprecated)

publicMap<String,String>getDimensions()

Use #getDimensionsMap() instead.

Returns
Type Description
Map<String,String>

getDimensionsCount()

publicintgetDimensionsCount()

If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.

For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the override is only applied to quota consumed in that region.

This map has the following restrictions:

  • Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
  • project is not a valid key; the project is already specified in the parent resource name.
  • user is not a valid key; the API does not support quota overrides that apply only to a specific user.
  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • If any valid key other than region or zone appears in the map, then all valid keys other than region or zone must also appear in the map.

map<string, string> dimensions = 3;

Returns
Type Description
int

getDimensionsMap()

publicMap<String,String>getDimensionsMap()

If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.

For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the override is only applied to quota consumed in that region.

This map has the following restrictions:

  • Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
  • project is not a valid key; the project is already specified in the parent resource name.
  • user is not a valid key; the API does not support quota overrides that apply only to a specific user.
  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • If any valid key other than region or zone appears in the map, then all valid keys other than region or zone must also appear in the map.

map<string, string> dimensions = 3;

Returns
Type Description
Map<String,String>

getDimensionsOrDefault(String key, String defaultValue)

publicStringgetDimensionsOrDefault(Stringkey,StringdefaultValue)

If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.

For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the override is only applied to quota consumed in that region.

This map has the following restrictions:

  • Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
  • project is not a valid key; the project is already specified in the parent resource name.
  • user is not a valid key; the API does not support quota overrides that apply only to a specific user.
  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • If any valid key other than region or zone appears in the map, then all valid keys other than region or zone must also appear in the map.

map<string, string> dimensions = 3;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getDimensionsOrThrow(String key)

publicStringgetDimensionsOrThrow(Stringkey)

If this map is nonempty, then this override applies only to specific values for dimensions defined in the limit unit.

For example, an override on a limit with the unit 1/{project}/{region} could contain an entry with the key region and the value us-east-1; the override is only applied to quota consumed in that region.

This map has the following restrictions:

  • Keys that are not defined in the limit's unit are not valid keys. Any string appearing in {brackets} in the unit (besides {project} or {user}) is a defined key.
  • project is not a valid key; the project is already specified in the parent resource name.
  • user is not a valid key; the API does not support quota overrides that apply only to a specific user.
  • If region appears as a key, its value must be a valid Cloud region.
  • If zone appears as a key, its value must be a valid Cloud zone.
  • If any valid key other than region or zone appears in the map, then all valid keys other than region or zone must also appear in the map.

map<string, string> dimensions = 3;

Parameter
Name Description
key String
Returns
Type Description
String

getMetric()

publicStringgetMetric()

The name of the metric to which this override applies.

An example name would be: compute.googleapis.com/cpus

string metric = 4;

Returns
Type Description
String

The metric.

getMetricBytes()

publicByteStringgetMetricBytes()

The name of the metric to which this override applies.

An example name would be: compute.googleapis.com/cpus

string metric = 4;

Returns
Type Description
ByteString

The bytes for metric.

getName()

publicStringgetName()

The resource name of the override. This name is generated by the server when the override is created.

Example names would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d

The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

string name = 1;

Returns
Type Description
String

The name.

getNameBytes()

publicByteStringgetNameBytes()

The resource name of the override. This name is generated by the server when the override is created.

Example names would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminOverrides/4a3f2c1d projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/consumerOverrides/4a3f2c1d

The resource name is intended to be opaque and should not be parsed for its component strings, since its representation could change in the future.

string name = 1;

Returns
Type Description
ByteString

The bytes for name.

getOverrideValue()

publiclonggetOverrideValue()

The overriding quota limit value. Can be any nonnegative integer, or -1 (unlimited quota).

int64 override_value = 2;

Returns
Type Description
long

The overrideValue.

getParserForType()

publicParser<QuotaOverride>getParserForType()
Returns
Type Description
Parser<QuotaOverride>
Overrides

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getUnit()

publicStringgetUnit()

The limit unit of the limit to which this override applies.

An example unit would be: 1/{project}/{region} Note that {project} and {region} are not placeholders in this example; the literal characters { and } occur in the string.

string unit = 5;

Returns
Type Description
String

The unit.

getUnitBytes()

publicByteStringgetUnitBytes()

The limit unit of the limit to which this override applies.

An example unit would be: 1/{project}/{region} Note that {project} and {region} are not placeholders in this example; the literal characters { and } occur in the string.

string unit = 5;

Returns
Type Description
ByteString

The bytes for unit.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

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

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicQuotaOverride.BuildernewBuilderForType()
Returns
Type Description
QuotaOverride.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedQuotaOverride.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QuotaOverride.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicQuotaOverride.BuildertoBuilder()
Returns
Type Description
QuotaOverride.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.