public final class QuotaOverride extends GeneratedMessageV3 implements QuotaOverrideOrBuilder
A quota override
Protobuf type google.api.serviceusage.v1beta1.QuotaOverride
Static Fields
ADMIN_OVERRIDE_ANCESTOR_FIELD_NUMBER
public static final int ADMIN_OVERRIDE_ANCESTOR_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
METRIC_FIELD_NUMBER
public static final int METRIC_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
OVERRIDE_VALUE_FIELD_NUMBER
public static final int OVERRIDE_VALUE_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
UNIT_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static QuotaOverride getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static QuotaOverride.Builder newBuilder()
newBuilder(QuotaOverride prototype)
public static QuotaOverride.Builder newBuilder(QuotaOverride prototype)
public static QuotaOverride parseDelimitedFrom(InputStream input)
public static QuotaOverride parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static QuotaOverride parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QuotaOverride parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static QuotaOverride parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QuotaOverride parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QuotaOverride parseFrom(CodedInputStream input)
public static QuotaOverride parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QuotaOverride parseFrom(InputStream input)
public static QuotaOverride parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static QuotaOverride parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QuotaOverride parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<QuotaOverride> parser()
Methods
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
|
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
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()
getDimensions()
public Map<String,String> getDimensions()
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;
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;
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
|
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.
|
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.
|
getParserForType()
public Parser<QuotaOverride> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
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.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Overrides
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public QuotaOverride.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QuotaOverride.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public QuotaOverride.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
