Class QuotaOverride.Builder (2.29.0)

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

A quota override

Protobuf type google.api.serviceusage.v1beta1.QuotaOverride

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public QuotaOverride build()
Returns
TypeDescription
QuotaOverride

buildPartial()

public QuotaOverride buildPartial()
Returns
TypeDescription
QuotaOverride

clear()

public QuotaOverride.Builder clear()
Returns
TypeDescription
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
TypeDescription
QuotaOverride.Builder

This builder for chaining.

clearDimensions()

public QuotaOverride.Builder clearDimensions()
Returns
TypeDescription
QuotaOverride.Builder

clearField(Descriptors.FieldDescriptor field)

public QuotaOverride.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
QuotaOverride.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public QuotaOverride.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
QuotaOverride.Builder

This builder for chaining.

clone()

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

The bytes for adminOverrideAncestor.

getDefaultInstanceForType()

public QuotaOverride getDefaultInstanceForType()
Returns
TypeDescription
QuotaOverride

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

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

The bytes for metric.

getMutableDimensions()

public Map<String,String> getMutableDimensions()

Use alternate mutation accessors instead.

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

The bytes for unit.

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

mergeFrom(QuotaOverride other)

public QuotaOverride.Builder mergeFrom(QuotaOverride other)
Parameter
NameDescription
otherQuotaOverride
Returns
TypeDescription
QuotaOverride.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

public QuotaOverride.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
QuotaOverride.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

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

The adminOverrideAncestor to set.

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

The bytes for adminOverrideAncestor to set.

Returns
TypeDescription
QuotaOverride.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

The metric to set.

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

The bytes for metric to set.

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

The name to set.

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

The bytes for name to set.

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

The overrideValue to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
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
NameDescription
valueString

The unit to set.

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

The bytes for unit to set.

Returns
TypeDescription
QuotaOverride.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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