Interface QuotaOverrideOrBuilder (2.55.0) 

public interface QuotaOverrideOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsDimensions(String key)

public abstract 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 abstract 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 abstract 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.

getDimensions() (deprecated)

public abstract Map<String,String> getDimensions()

Use #getDimensionsMap() instead.

Returns
Type Description
Map<String,String>

getDimensionsCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getName()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.