Class ProducerQuotaPolicy (2.30.0)

public final class ProducerQuotaPolicy extends GeneratedMessageV3 implements ProducerQuotaPolicyOrBuilder

Quota policy created by service producer.

Protobuf type google.api.serviceusage.v1beta1.ProducerQuotaPolicy

Static Fields

CONTAINER_FIELD_NUMBER

public static final int CONTAINER_FIELD_NUMBER
Field Value
TypeDescription
int

DIMENSIONS_FIELD_NUMBER

public static final int DIMENSIONS_FIELD_NUMBER
Field Value
TypeDescription
int

METRIC_FIELD_NUMBER

public static final int METRIC_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

POLICY_VALUE_FIELD_NUMBER

public static final int POLICY_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

UNIT_FIELD_NUMBER

public static final int UNIT_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ProducerQuotaPolicy getDefaultInstance()
Returns
TypeDescription
ProducerQuotaPolicy

getDescriptor()

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

newBuilder()

public static ProducerQuotaPolicy.Builder newBuilder()
Returns
TypeDescription
ProducerQuotaPolicy.Builder

newBuilder(ProducerQuotaPolicy prototype)

public static ProducerQuotaPolicy.Builder newBuilder(ProducerQuotaPolicy prototype)
Parameter
NameDescription
prototypeProducerQuotaPolicy
Returns
TypeDescription
ProducerQuotaPolicy.Builder

parseDelimitedFrom(InputStream input)

public static ProducerQuotaPolicy parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProducerQuotaPolicy parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ProducerQuotaPolicy parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ProducerQuotaPolicy parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ProducerQuotaPolicy parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ProducerQuotaPolicy parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ProducerQuotaPolicy parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ProducerQuotaPolicy parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ProducerQuotaPolicy parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ProducerQuotaPolicy parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ProducerQuotaPolicy parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ProducerQuotaPolicy parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ProducerQuotaPolicy
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ProducerQuotaPolicy> parser()
Returns
TypeDescription
Parser<ProducerQuotaPolicy>

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, a 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:

  • 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 policies 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

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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;

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

Returns
TypeDescription
ByteString

The bytes for container.

getDefaultInstanceForType()

public ProducerQuotaPolicy getDefaultInstanceForType()
Returns
TypeDescription
ProducerQuotaPolicy

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 policy applies only to specific values for dimensions defined in the limit unit.

For example, a 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:

  • 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 policies 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 policy applies only to specific values for dimensions defined in the limit unit.

For example, a 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:

  • 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 policies 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 policy applies only to specific values for dimensions defined in the limit unit.

For example, a 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:

  • 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 policies 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 policy applies only to specific values for dimensions defined in the limit unit.

For example, a 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:

  • 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 policies 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 policy 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 policy applies.

An example name would be: compute.googleapis.com/cpus

string metric = 4;

Returns
TypeDescription
ByteString

The bytes for metric.

getName()

public String 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/producerQuotaPolicies/4a3f2c1d

string name = 1;

Returns
TypeDescription
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/producerQuotaPolicies/4a3f2c1d

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<ProducerQuotaPolicy> getParserForType()
Returns
TypeDescription
Parser<ProducerQuotaPolicy>
Overrides

getPolicyValue()

public long getPolicyValue()

The quota policy value. Can be any nonnegative integer, or -1 (unlimited quota).

int64 policy_value = 2;

Returns
TypeDescription
long

The policyValue.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnit()

public String 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;

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

Returns
TypeDescription
ByteString

The bytes for unit.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

protected MapField internalGetMapField(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
MapField
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ProducerQuotaPolicy.Builder newBuilderForType()
Returns
TypeDescription
ProducerQuotaPolicy.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ProducerQuotaPolicy.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ProducerQuotaPolicy.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ProducerQuotaPolicy.Builder toBuilder()
Returns
TypeDescription
ProducerQuotaPolicy.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException