Class ConsumerQuotaLimit (2.44.0)

public final class ConsumerQuotaLimit extends GeneratedMessageV3 implements ConsumerQuotaLimitOrBuilder

Consumer quota settings for a quota limit.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaLimit

Static Fields

ALLOWS_ADMIN_OVERRIDES_FIELD_NUMBER

public static final int ALLOWS_ADMIN_OVERRIDES_FIELD_NUMBER
Field Value
Type Description
int

IS_PRECISE_FIELD_NUMBER

public static final int IS_PRECISE_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

QUOTA_BUCKETS_FIELD_NUMBER

public static final int QUOTA_BUCKETS_FIELD_NUMBER
Field Value
Type Description
int

SUPPORTED_LOCATIONS_FIELD_NUMBER

public static final int SUPPORTED_LOCATIONS_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 ConsumerQuotaLimit getDefaultInstance()
Returns
Type Description
ConsumerQuotaLimit

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ConsumerQuotaLimit.Builder newBuilder()
Returns
Type Description
ConsumerQuotaLimit.Builder

newBuilder(ConsumerQuotaLimit prototype)

public static ConsumerQuotaLimit.Builder newBuilder(ConsumerQuotaLimit prototype)
Parameter
Name Description
prototype ConsumerQuotaLimit
Returns
Type Description
ConsumerQuotaLimit.Builder

parseDelimitedFrom(InputStream input)

public static ConsumerQuotaLimit parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsumerQuotaLimit parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ConsumerQuotaLimit parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ConsumerQuotaLimit parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ConsumerQuotaLimit parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ConsumerQuotaLimit parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ConsumerQuotaLimit parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsumerQuotaLimit parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ConsumerQuotaLimit parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ConsumerQuotaLimit parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ConsumerQuotaLimit parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ConsumerQuotaLimit parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ConsumerQuotaLimit
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ConsumerQuotaLimit> parser()
Returns
Type Description
Parser<ConsumerQuotaLimit>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAllowsAdminOverrides()

public boolean getAllowsAdminOverrides()

Whether admin overrides are allowed on this limit

bool allows_admin_overrides = 7;

Returns
Type Description
boolean

The allowsAdminOverrides.

getDefaultInstanceForType()

public ConsumerQuotaLimit getDefaultInstanceForType()
Returns
Type Description
ConsumerQuotaLimit

getIsPrecise()

public boolean getIsPrecise()

Whether this limit is precise or imprecise.

bool is_precise = 3;

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<ConsumerQuotaLimit> getParserForType()
Returns
Type Description
Parser<ConsumerQuotaLimit>
Overrides

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
Name Description
index int
Returns
Type Description
QuotaBucket

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
Type Description
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
Type Description
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
Name Description
index int
Returns
Type Description
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
Type Description
List<? extends com.google.api.serviceusage.v1beta1.QuotaBucketOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
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
Type Description
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
Type Description
ByteString

The bytes for unit.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ConsumerQuotaLimit.Builder newBuilderForType()
Returns
Type Description
ConsumerQuotaLimit.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ConsumerQuotaLimit.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ConsumerQuotaLimit.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ConsumerQuotaLimit.Builder toBuilder()
Returns
Type Description
ConsumerQuotaLimit.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException