Class AdminQuotaPolicy.Builder (2.18.0)

public static final class AdminQuotaPolicy.Builder extends GeneratedMessageV3.Builder<AdminQuotaPolicy.Builder> implements AdminQuotaPolicyOrBuilder

Quota policy created by quota administrator.

Protobuf type google.api.serviceusage.v1beta1.AdminQuotaPolicy

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public AdminQuotaPolicy.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

build()

public AdminQuotaPolicy build()
Returns
TypeDescription
AdminQuotaPolicy

buildPartial()

public AdminQuotaPolicy buildPartial()
Returns
TypeDescription
AdminQuotaPolicy

clear()

public AdminQuotaPolicy.Builder clear()
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

clearContainer()

public AdminQuotaPolicy.Builder clearContainer()

The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}

string container = 6;

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

clearDimensions()

public AdminQuotaPolicy.Builder clearDimensions()
Returns
TypeDescription
AdminQuotaPolicy.Builder

clearField(Descriptors.FieldDescriptor field)

public AdminQuotaPolicy.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

clearMetric()

public AdminQuotaPolicy.Builder clearMetric()

The name of the metric to which this policy applies. An example name would be: compute.googleapis.com/cpus

string metric = 4;

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

clearName()

public AdminQuotaPolicy.Builder clearName()

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;

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public AdminQuotaPolicy.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

clearPolicyValue()

public AdminQuotaPolicy.Builder clearPolicyValue()

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

int64 policy_value = 2;

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

clearUnit()

public AdminQuotaPolicy.Builder clearUnit()

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
AdminQuotaPolicy.Builder

This builder for chaining.

clone()

public AdminQuotaPolicy.Builder clone()
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

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;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

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 AdminQuotaPolicy getDefaultInstanceForType()
Returns
TypeDescription
AdminQuotaPolicy

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

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, 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;

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, 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;

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, 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;

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, 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;

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.

getMutableDimensions()

public Map<String,String> getMutableDimensions()

Use alternate mutation accessors instead.

Returns
TypeDescription
Map<String,String>

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/adminQuotaPolicies/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/adminQuotaPolicies/4a3f2c1d

string name = 1;

Returns
TypeDescription
ByteString

The bytes for name.

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.

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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapField(int number)

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

internalGetMutableMapField(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(AdminQuotaPolicy other)

public AdminQuotaPolicy.Builder mergeFrom(AdminQuotaPolicy other)
Parameter
NameDescription
otherAdminQuotaPolicy
Returns
TypeDescription
AdminQuotaPolicy.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public AdminQuotaPolicy.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public AdminQuotaPolicy.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final AdminQuotaPolicy.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

putAllDimensions(Map<String,String> values)

public AdminQuotaPolicy.Builder putAllDimensions(Map<String,String> values)

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;

Parameter
NameDescription
valuesMap<String,String>
Returns
TypeDescription
AdminQuotaPolicy.Builder

putDimensions(String key, String value)

public AdminQuotaPolicy.Builder putDimensions(String key, String value)

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;

Parameters
NameDescription
keyString
valueString
Returns
TypeDescription
AdminQuotaPolicy.Builder

removeDimensions(String key)

public AdminQuotaPolicy.Builder removeDimensions(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;

Parameter
NameDescription
keyString
Returns
TypeDescription
AdminQuotaPolicy.Builder

setContainer(String value)

public AdminQuotaPolicy.Builder setContainer(String value)

The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}

string container = 6;

Parameter
NameDescription
valueString

The container to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setContainerBytes(ByteString value)

public AdminQuotaPolicy.Builder setContainerBytes(ByteString value)

The cloud resource container at which the quota policy is created. The format is {container_type}/{container_number}

string container = 6;

Parameter
NameDescription
valueByteString

The bytes for container to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public AdminQuotaPolicy.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

setMetric(String value)

public AdminQuotaPolicy.Builder setMetric(String value)

The name of the metric to which this policy applies. An example name would be: compute.googleapis.com/cpus

string metric = 4;

Parameter
NameDescription
valueString

The metric to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setMetricBytes(ByteString value)

public AdminQuotaPolicy.Builder setMetricBytes(ByteString value)

The name of the metric to which this policy applies. An example name would be: compute.googleapis.com/cpus

string metric = 4;

Parameter
NameDescription
valueByteString

The bytes for metric to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setName(String value)

public AdminQuotaPolicy.Builder setName(String value)

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setNameBytes(ByteString value)

public AdminQuotaPolicy.Builder setNameBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setPolicyValue(long value)

public AdminQuotaPolicy.Builder setPolicyValue(long value)

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

int64 policy_value = 2;

Parameter
NameDescription
valuelong

The policyValue to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public AdminQuotaPolicy.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides

setUnit(String value)

public AdminQuotaPolicy.Builder setUnit(String value)

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;

Parameter
NameDescription
valueString

The unit to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setUnitBytes(ByteString value)

public AdminQuotaPolicy.Builder setUnitBytes(ByteString value)

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;

Parameter
NameDescription
valueByteString

The bytes for unit to set.

Returns
TypeDescription
AdminQuotaPolicy.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final AdminQuotaPolicy.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
AdminQuotaPolicy.Builder
Overrides