public final class AdminQuotaPolicy extends GeneratedMessageV3 implements AdminQuotaPolicyOrBuilder
Quota policy created by quota administrator.
Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy
Static Fields
CONTAINER_FIELD_NUMBER
public static final int CONTAINER_FIELD_NUMBER
Field Value
DIMENSIONS_FIELD_NUMBER
public static final int DIMENSIONS_FIELD_NUMBER
Field Value
METRIC_FIELD_NUMBER
public static final int METRIC_FIELD_NUMBER
Field Value
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
Field Value
POLICY_VALUE_FIELD_NUMBER
public static final int POLICY_VALUE_FIELD_NUMBER
Field Value
UNIT_FIELD_NUMBER
public static final int UNIT_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static AdminQuotaPolicy getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static AdminQuotaPolicy.Builder newBuilder()
Returns
newBuilder(AdminQuotaPolicy prototype)
public static AdminQuotaPolicy.Builder newBuilder(AdminQuotaPolicy prototype)
Parameter
Returns
public static AdminQuotaPolicy parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static AdminQuotaPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static AdminQuotaPolicy parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AdminQuotaPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static AdminQuotaPolicy parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AdminQuotaPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AdminQuotaPolicy parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static AdminQuotaPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static AdminQuotaPolicy parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static AdminQuotaPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static AdminQuotaPolicy parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AdminQuotaPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<AdminQuotaPolicy> parser()
Returns
Methods
containsDimensions(String key)
public boolean containsDimensions(String key)
If this map is nonempty, then this policy applies only to specific values
for dimensions defined in the limit unit.
For example, an policy on a limit with the unit 1/{project}/{region}
could contain an entry with the key region and the value us-east-1;
the policy is only applied to quota consumed in that region.
This map has the following restrictions:
- 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.
- Keys other than
region or zone are not valid.
map<string, string> dimensions = 3;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getContainer()
public String getContainer()
The cloud resource container at which the quota policy is created. The
format is {container_type}/{container_number}
string container = 6;
| Type | Description |
String | The container.
|
getContainerBytes()
public ByteString getContainerBytes()
The cloud resource container at which the quota policy is created. The
format is {container_type}/{container_number}
string container = 6;
getDefaultInstanceForType()
public AdminQuotaPolicy getDefaultInstanceForType()
Returns
getDimensions()
public Map<String,String> getDimensions()
Returns
getDimensionsCount()
public int getDimensionsCount()
If this map is nonempty, then this policy applies only to specific values
for dimensions defined in the limit unit.
For example, an policy on a limit with the unit 1/{project}/{region}
could contain an entry with the key region and the value us-east-1;
the policy is only applied to quota consumed in that region.
This map has the following restrictions:
- 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.
- Keys other than
region or zone are not valid.
map<string, string> dimensions = 3;
getDimensionsMap()
public Map<String,String> getDimensionsMap()
If this map is nonempty, then this policy applies only to specific values
for dimensions defined in the limit unit.
For example, an policy on a limit with the unit 1/{project}/{region}
could contain an entry with the key region and the value us-east-1;
the policy is only applied to quota consumed in that region.
This map has the following restrictions:
- 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.
- Keys other than
region or zone are not valid.
map<string, string> dimensions = 3;
getDimensionsOrDefault(String key, String defaultValue)
public String getDimensionsOrDefault(String key, String defaultValue)
If this map is nonempty, then this policy applies only to specific values
for dimensions defined in the limit unit.
For example, an policy on a limit with the unit 1/{project}/{region}
could contain an entry with the key region and the value us-east-1;
the policy is only applied to quota consumed in that region.
This map has the following restrictions:
- 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.
- Keys other than
region or zone are not valid.
map<string, string> dimensions = 3;
getDimensionsOrThrow(String key)
public String getDimensionsOrThrow(String key)
If this map is nonempty, then this policy applies only to specific values
for dimensions defined in the limit unit.
For example, an policy on a limit with the unit 1/{project}/{region}
could contain an entry with the key region and the value us-east-1;
the policy is only applied to quota consumed in that region.
This map has the following restrictions:
- 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.
- Keys other than
region or zone are not valid.
map<string, string> dimensions = 3;
getMetric()
public String getMetric()
The name of the metric to which this policy applies.
An example name would be:
compute.googleapis.com/cpus
string metric = 4;
| Type | Description |
String | The metric.
|
getMetricBytes()
public ByteString getMetricBytes()
The name of the metric to which this policy applies.
An example name would be:
compute.googleapis.com/cpus
string metric = 4;
getName()
The resource name of the policy.
This name is generated by the server when the policy is created.
Example names would be:
organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d
string name = 1;
| Type | Description |
String | The name.
|
getNameBytes()
public ByteString getNameBytes()
The resource name of the policy.
This name is generated by the server when the policy is created.
Example names would be:
organizations/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion/adminQuotaPolicies/4a3f2c1d
string name = 1;
getParserForType()
public Parser<AdminQuotaPolicy> getParserForType()
Returns
Overrides
getPolicyValue()
public long getPolicyValue()
The quota policy value.
Can be any nonnegative integer, or -1 (unlimited quota).
int64 policy_value = 2;
| Type | Description |
long | The policyValue.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnit()
The limit unit of the limit to which this policy 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;
| Type | Description |
String | The unit.
|
getUnitBytes()
public ByteString getUnitBytes()
The limit unit of the limit to which this policy 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;
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public AdminQuotaPolicy.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AdminQuotaPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public AdminQuotaPolicy.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
