Class QuotaOverride.Builder (2.44.0) 

public static final class QuotaOverride.Builder extends GeneratedMessageV3.Builder<QuotaOverride.Builder> implements QuotaOverrideOrBuilder

A quota override

Protobuf type google.api.serviceusage.v1beta1.QuotaOverride

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > QuotaOverride.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public QuotaOverride build()
Returns
Type Description
QuotaOverride

buildPartial()

public QuotaOverride buildPartial()
Returns
Type Description
QuotaOverride

clear()

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

clearAdminOverrideAncestor()

public QuotaOverride.Builder clearAdminOverrideAncestor()

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
QuotaOverride.Builder

This builder for chaining.

clearDimensions()

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

clearField(Descriptors.FieldDescriptor field)

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

clearMetric()

public QuotaOverride.Builder clearMetric()

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
QuotaOverride.Builder

This builder for chaining.

clearName()

public QuotaOverride.Builder clearName()

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
QuotaOverride.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearOverrideValue()

public QuotaOverride.Builder clearOverrideValue()

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

int64 override_value = 2;

Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

clearUnit()

public QuotaOverride.Builder clearUnit()

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
QuotaOverride.Builder

This builder for chaining.

clone()

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

containsDimensions(String key)

public boolean containsDimensions(String key)

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

getAdminOverrideAncestor()

public String getAdminOverrideAncestor()

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()

public ByteString getAdminOverrideAncestorBytes()

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()

public QuotaOverride getDefaultInstanceForType()
Returns
Type Description
QuotaOverride

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()

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()

public Map<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)

public String getDimensionsOrDefault(String key, String defaultValue)

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)

public String getDimensionsOrThrow(String key)

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()

public String getMetric()

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()

public ByteString getMetricBytes()

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.

getMutableDimensions() (deprecated)

public Map<String,String> getMutableDimensions()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

getName()

public String getName()

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()

public ByteString getNameBytes()

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()

public long getOverrideValue()

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

int64 override_value = 2;

Returns
Type Description
long

The overrideValue.

getUnit()

public String getUnit()

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()

public ByteString getUnitBytes()

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.

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

mergeFrom(QuotaOverride other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

putAllDimensions(Map<String,String> values)

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

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
values Map<String,String>
Returns
Type Description
QuotaOverride.Builder

putDimensions(String key, String value)

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

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
value String
Returns
Type Description
QuotaOverride.Builder

removeDimensions(String key)

public QuotaOverride.Builder removeDimensions(String key)

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
QuotaOverride.Builder

setAdminOverrideAncestor(String value)

public QuotaOverride.Builder setAdminOverrideAncestor(String value)

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;

Parameter
Name Description
value String

The adminOverrideAncestor to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setAdminOverrideAncestorBytes(ByteString value)

public QuotaOverride.Builder setAdminOverrideAncestorBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for adminOverrideAncestor to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setMetric(String value)

public QuotaOverride.Builder setMetric(String value)

The name of the metric to which this override applies.

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

string metric = 4;

Parameter
Name Description
value String

The metric to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setMetricBytes(ByteString value)

public QuotaOverride.Builder setMetricBytes(ByteString value)

The name of the metric to which this override applies.

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

string metric = 4;

Parameter
Name Description
value ByteString

The bytes for metric to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setName(String value)

public QuotaOverride.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setNameBytes(ByteString value)

public QuotaOverride.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setOverrideValue(long value)

public QuotaOverride.Builder setOverrideValue(long value)

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

int64 override_value = 2;

Parameter
Name Description
value long

The overrideValue to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

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

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

setUnit(String value)

public QuotaOverride.Builder setUnit(String value)

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;

Parameter
Name Description
value String

The unit to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setUnitBytes(ByteString value)

public QuotaOverride.Builder setUnitBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for unit to set.
Returns
Type Description
QuotaOverride.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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