Class ConsumerQuotaLimit.Builder (2.32.0)

public static final class ConsumerQuotaLimit.Builder extends GeneratedMessageV3.Builder<ConsumerQuotaLimit.Builder> implements ConsumerQuotaLimitOrBuilder

Consumer quota settings for a quota limit.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaLimit

Static Methods

getDescriptor()

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

Methods

addAllQuotaBuckets(Iterable<? extends QuotaBucket> values)

public ConsumerQuotaLimit.Builder addAllQuotaBuckets(Iterable<? extends QuotaBucket> values)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
valuesIterable<? extends com.google.api.serviceusage.v1beta1.QuotaBucket>
Returns
TypeDescription
ConsumerQuotaLimit.Builder

addAllSupportedLocations(Iterable<String> values)

public ConsumerQuotaLimit.Builder addAllSupportedLocations(Iterable<String> values)

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Parameter
NameDescription
valuesIterable<String>

The supportedLocations to add.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

addQuotaBuckets(QuotaBucket value)

public ConsumerQuotaLimit.Builder addQuotaBuckets(QuotaBucket value)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
valueQuotaBucket
Returns
TypeDescription
ConsumerQuotaLimit.Builder

addQuotaBuckets(QuotaBucket.Builder builderForValue)

public ConsumerQuotaLimit.Builder addQuotaBuckets(QuotaBucket.Builder builderForValue)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
builderForValueQuotaBucket.Builder
Returns
TypeDescription
ConsumerQuotaLimit.Builder

addQuotaBuckets(int index, QuotaBucket value)

public ConsumerQuotaLimit.Builder addQuotaBuckets(int index, QuotaBucket value)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameters
NameDescription
indexint
valueQuotaBucket
Returns
TypeDescription
ConsumerQuotaLimit.Builder

addQuotaBuckets(int index, QuotaBucket.Builder builderForValue)

public ConsumerQuotaLimit.Builder addQuotaBuckets(int index, QuotaBucket.Builder builderForValue)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameters
NameDescription
indexint
builderForValueQuotaBucket.Builder
Returns
TypeDescription
ConsumerQuotaLimit.Builder

addQuotaBucketsBuilder()

public QuotaBucket.Builder addQuotaBucketsBuilder()

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Returns
TypeDescription
QuotaBucket.Builder

addQuotaBucketsBuilder(int index)

public QuotaBucket.Builder addQuotaBucketsBuilder(int index)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
QuotaBucket.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

addSupportedLocations(String value)

public ConsumerQuotaLimit.Builder addSupportedLocations(String value)

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Parameter
NameDescription
valueString

The supportedLocations to add.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

addSupportedLocationsBytes(ByteString value)

public ConsumerQuotaLimit.Builder addSupportedLocationsBytes(ByteString value)

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Parameter
NameDescription
valueByteString

The bytes of the supportedLocations to add.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

build()

public ConsumerQuotaLimit build()
Returns
TypeDescription
ConsumerQuotaLimit

buildPartial()

public ConsumerQuotaLimit buildPartial()
Returns
TypeDescription
ConsumerQuotaLimit

clear()

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

clearAllowsAdminOverrides()

public ConsumerQuotaLimit.Builder clearAllowsAdminOverrides()

Whether admin overrides are allowed on this limit

bool allows_admin_overrides = 7;

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

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

clearIsPrecise()

public ConsumerQuotaLimit.Builder clearIsPrecise()

Whether this limit is precise or imprecise.

bool is_precise = 3;

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

clearMetric()

public ConsumerQuotaLimit.Builder clearMetric()

The name of the parent metric of this limit.

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

string metric = 8;

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

clearName()

public ConsumerQuotaLimit.Builder clearName()

The resource name of the quota limit.

An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

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
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearQuotaBuckets()

public ConsumerQuotaLimit.Builder clearQuotaBuckets()

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Returns
TypeDescription
ConsumerQuotaLimit.Builder

clearSupportedLocations()

public ConsumerQuotaLimit.Builder clearSupportedLocations()

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

clearUnit()

public ConsumerQuotaLimit.Builder clearUnit()

The limit unit.

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 = 2;

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

clone()

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

getAllowsAdminOverrides()

public boolean getAllowsAdminOverrides()

Whether admin overrides are allowed on this limit

bool allows_admin_overrides = 7;

Returns
TypeDescription
boolean

The allowsAdminOverrides.

getDefaultInstanceForType()

public ConsumerQuotaLimit getDefaultInstanceForType()
Returns
TypeDescription
ConsumerQuotaLimit

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
Overrides

getIsPrecise()

public boolean getIsPrecise()

Whether this limit is precise or imprecise.

bool is_precise = 3;

Returns
TypeDescription
boolean

The isPrecise.

getMetric()

public String getMetric()

The name of the parent metric of this limit.

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

string metric = 8;

Returns
TypeDescription
String

The metric.

getMetricBytes()

public ByteString getMetricBytes()

The name of the parent metric of this limit.

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

string metric = 8;

Returns
TypeDescription
ByteString

The bytes for metric.

getName()

public String getName()

The resource name of the quota limit.

An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

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
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the quota limit.

An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

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
TypeDescription
ByteString

The bytes for name.

getQuotaBuckets(int index)

public QuotaBucket getQuotaBuckets(int index)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
QuotaBucket

getQuotaBucketsBuilder(int index)

public QuotaBucket.Builder getQuotaBucketsBuilder(int index)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
QuotaBucket.Builder

getQuotaBucketsBuilderList()

public List<QuotaBucket.Builder> getQuotaBucketsBuilderList()

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Returns
TypeDescription
List<Builder>

getQuotaBucketsCount()

public int getQuotaBucketsCount()

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Returns
TypeDescription
int

getQuotaBucketsList()

public List<QuotaBucket> getQuotaBucketsList()

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Returns
TypeDescription
List<QuotaBucket>

getQuotaBucketsOrBuilder(int index)

public QuotaBucketOrBuilder getQuotaBucketsOrBuilder(int index)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
QuotaBucketOrBuilder

getQuotaBucketsOrBuilderList()

public List<? extends QuotaBucketOrBuilder> getQuotaBucketsOrBuilderList()

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Returns
TypeDescription
List<? extends com.google.api.serviceusage.v1beta1.QuotaBucketOrBuilder>

getSupportedLocations(int index)

public String getSupportedLocations(int index)

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The supportedLocations at the given index.

getSupportedLocationsBytes(int index)

public ByteString getSupportedLocationsBytes(int index)

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the supportedLocations at the given index.

getSupportedLocationsCount()

public int getSupportedLocationsCount()

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Returns
TypeDescription
int

The count of supportedLocations.

getSupportedLocationsList()

public ProtocolStringList getSupportedLocationsList()

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Returns
TypeDescription
ProtocolStringList

A list containing the supportedLocations.

getUnit()

public String getUnit()

The limit unit.

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 = 2;

Returns
TypeDescription
String

The unit.

getUnitBytes()

public ByteString getUnitBytes()

The limit unit.

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 = 2;

Returns
TypeDescription
ByteString

The bytes for unit.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(ConsumerQuotaLimit other)

public ConsumerQuotaLimit.Builder mergeFrom(ConsumerQuotaLimit other)
Parameter
NameDescription
otherConsumerQuotaLimit
Returns
TypeDescription
ConsumerQuotaLimit.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

removeQuotaBuckets(int index)

public ConsumerQuotaLimit.Builder removeQuotaBuckets(int index)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameter
NameDescription
indexint
Returns
TypeDescription
ConsumerQuotaLimit.Builder

setAllowsAdminOverrides(boolean value)

public ConsumerQuotaLimit.Builder setAllowsAdminOverrides(boolean value)

Whether admin overrides are allowed on this limit

bool allows_admin_overrides = 7;

Parameter
NameDescription
valueboolean

The allowsAdminOverrides to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

setIsPrecise(boolean value)

public ConsumerQuotaLimit.Builder setIsPrecise(boolean value)

Whether this limit is precise or imprecise.

bool is_precise = 3;

Parameter
NameDescription
valueboolean

The isPrecise to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setMetric(String value)

public ConsumerQuotaLimit.Builder setMetric(String value)

The name of the parent metric of this limit.

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

string metric = 8;

Parameter
NameDescription
valueString

The metric to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setMetricBytes(ByteString value)

public ConsumerQuotaLimit.Builder setMetricBytes(ByteString value)

The name of the parent metric of this limit.

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

string metric = 8;

Parameter
NameDescription
valueByteString

The bytes for metric to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setName(String value)

public ConsumerQuotaLimit.Builder setName(String value)

The resource name of the quota limit.

An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

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;

Parameter
NameDescription
valueString

The name to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setNameBytes(ByteString value)

public ConsumerQuotaLimit.Builder setNameBytes(ByteString value)

The resource name of the quota limit.

An example name would be: projects/123/services/compute.googleapis.com/consumerQuotaMetrics/compute.googleapis.com%2Fcpus/limits/%2Fproject%2Fregion

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;

Parameter
NameDescription
valueByteString

The bytes for name to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setQuotaBuckets(int index, QuotaBucket value)

public ConsumerQuotaLimit.Builder setQuotaBuckets(int index, QuotaBucket value)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameters
NameDescription
indexint
valueQuotaBucket
Returns
TypeDescription
ConsumerQuotaLimit.Builder

setQuotaBuckets(int index, QuotaBucket.Builder builderForValue)

public ConsumerQuotaLimit.Builder setQuotaBuckets(int index, QuotaBucket.Builder builderForValue)

Summary of the enforced quota buckets, organized by quota dimension, ordered from least specific to most specific (for example, the global default bucket, with no quota dimensions, will always appear first).

repeated .google.api.serviceusage.v1beta1.QuotaBucket quota_buckets = 9;

Parameters
NameDescription
indexint
builderForValueQuotaBucket.Builder
Returns
TypeDescription
ConsumerQuotaLimit.Builder

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

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

setSupportedLocations(int index, String value)

public ConsumerQuotaLimit.Builder setSupportedLocations(int index, String value)

List of all supported locations. This field is present only if the limit has a {region} or {zone} dimension.

repeated string supported_locations = 11;

Parameters
NameDescription
indexint

The index to set the value at.

valueString

The supportedLocations to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setUnit(String value)

public ConsumerQuotaLimit.Builder setUnit(String value)

The limit unit.

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 = 2;

Parameter
NameDescription
valueString

The unit to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setUnitBytes(ByteString value)

public ConsumerQuotaLimit.Builder setUnitBytes(ByteString value)

The limit unit.

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 = 2;

Parameter
NameDescription
valueByteString

The bytes for unit to set.

Returns
TypeDescription
ConsumerQuotaLimit.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

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