Interface QuotaOverrideOrBuilder (2.58.0)
Stay organized with collections
Save and categorize content based on your preferences.
- 2.80.0 (latest)
- 2.78.0
- 2.76.0
- 2.75.0
- 2.74.0
- 2.73.0
- 2.72.0
- 2.70.0
- 2.68.0
- 2.67.0
- 2.64.0
- 2.63.0
- 2.62.0
- 2.60.0
- 2.59.0
- 2.58.0
- 2.57.0
- 2.56.0
- 2.55.0
- 2.54.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.42.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.30.0
- 2.29.0
- 2.28.0
- 2.27.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.14.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.9.0
- 2.8.0
- 2.7.0
- 2.6.0
- 2.5.0
- 2.4.0
- 2.3.7
- 2.2.8
publicinterface QuotaOverrideOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
containsDimensions(String key)
publicabstractbooleancontainsDimensions(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. projectis not a valid key; the project is already specified in the parent resource name.useris not a valid key; the API does not support quota overrides that apply only to a specific user.- If
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - If any valid key other than
regionorzoneappears in the map, then all valid keys other thanregionorzonemust also appear in the map.
map<string, string> dimensions = 3;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getAdminOverrideAncestor()
publicabstractStringgetAdminOverrideAncestor() 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()
publicabstractByteStringgetAdminOverrideAncestorBytes() 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)
publicabstractMap<String,String>getDimensions()Use #getDimensionsMap() instead.
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getDimensionsCount()
publicabstractintgetDimensionsCount()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. projectis not a valid key; the project is already specified in the parent resource name.useris not a valid key; the API does not support quota overrides that apply only to a specific user.- If
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - If any valid key other than
regionorzoneappears in the map, then all valid keys other thanregionorzonemust also appear in the map.
map<string, string> dimensions = 3;
| Returns | |
|---|---|
| Type | Description |
int |
|
getDimensionsMap()
publicabstractMap<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. projectis not a valid key; the project is already specified in the parent resource name.useris not a valid key; the API does not support quota overrides that apply only to a specific user.- If
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - If any valid key other than
regionorzoneappears in the map, then all valid keys other thanregionorzonemust also appear in the map.
map<string, string> dimensions = 3;
| Returns | |
|---|---|
| Type | Description |
Map<String,String> |
|
getDimensionsOrDefault(String key, String defaultValue)
publicabstractStringgetDimensionsOrDefault(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. projectis not a valid key; the project is already specified in the parent resource name.useris not a valid key; the API does not support quota overrides that apply only to a specific user.- If
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - If any valid key other than
regionorzoneappears in the map, then all valid keys other thanregionorzonemust also appear in the map.
map<string, string> dimensions = 3;
| Parameters | |
|---|---|
| Name | Description |
key |
String |
defaultValue |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getDimensionsOrThrow(String key)
publicabstractStringgetDimensionsOrThrow(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. projectis not a valid key; the project is already specified in the parent resource name.useris not a valid key; the API does not support quota overrides that apply only to a specific user.- If
regionappears as a key, its value must be a valid Cloud region. - If
zoneappears as a key, its value must be a valid Cloud zone. - If any valid key other than
regionorzoneappears in the map, then all valid keys other thanregionorzonemust also appear in the map.
map<string, string> dimensions = 3;
| Parameter | |
|---|---|
| Name | Description |
key |
String |
| Returns | |
|---|---|
| Type | Description |
String |
|
getMetric()
publicabstractStringgetMetric()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()
publicabstractByteStringgetMetricBytes()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()
publicabstractStringgetName()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()
publicabstractByteStringgetNameBytes()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()
publicabstractlonggetOverrideValue()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()
publicabstractStringgetUnit()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()
publicabstractByteStringgetUnitBytes()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. |