Class ConsumerQuotaMetric (2.43.0)

public final class ConsumerQuotaMetric extends GeneratedMessageV3 implements ConsumerQuotaMetricOrBuilder

Consumer quota settings for a quota metric.

Protobuf type google.api.serviceusage.v1beta1.ConsumerQuotaMetric

Static Fields

CONSUMER_QUOTA_LIMITS_FIELD_NUMBER

public static final int CONSUMER_QUOTA_LIMITS_FIELD_NUMBER
Field Value
Type Description
int

DESCENDANT_CONSUMER_QUOTA_LIMITS_FIELD_NUMBER

public static final int DESCENDANT_CONSUMER_QUOTA_LIMITS_FIELD_NUMBER
Field Value
Type Description
int

DISPLAY_NAME_FIELD_NUMBER

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

UNIT_FIELD_NUMBER

public static final int UNIT_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ConsumerQuotaMetric getDefaultInstance()
Returns
Type Description
ConsumerQuotaMetric

getDescriptor()

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

newBuilder()

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

newBuilder(ConsumerQuotaMetric prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getConsumerQuotaLimits(int index)

public ConsumerQuotaLimit getConsumerQuotaLimits(int index)

The consumer quota for each quota limit defined on the metric.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit consumer_quota_limits = 3;

Parameter
Name Description
index int
Returns
Type Description
ConsumerQuotaLimit

getConsumerQuotaLimitsCount()

public int getConsumerQuotaLimitsCount()

The consumer quota for each quota limit defined on the metric.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit consumer_quota_limits = 3;

Returns
Type Description
int

getConsumerQuotaLimitsList()

public List<ConsumerQuotaLimit> getConsumerQuotaLimitsList()

The consumer quota for each quota limit defined on the metric.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit consumer_quota_limits = 3;

Returns
Type Description
List<ConsumerQuotaLimit>

getConsumerQuotaLimitsOrBuilder(int index)

public ConsumerQuotaLimitOrBuilder getConsumerQuotaLimitsOrBuilder(int index)

The consumer quota for each quota limit defined on the metric.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit consumer_quota_limits = 3;

Parameter
Name Description
index int
Returns
Type Description
ConsumerQuotaLimitOrBuilder

getConsumerQuotaLimitsOrBuilderList()

public List<? extends ConsumerQuotaLimitOrBuilder> getConsumerQuotaLimitsOrBuilderList()

The consumer quota for each quota limit defined on the metric.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit consumer_quota_limits = 3;

Returns
Type Description
List<? extends com.google.api.serviceusage.v1beta1.ConsumerQuotaLimitOrBuilder>

getDefaultInstanceForType()

public ConsumerQuotaMetric getDefaultInstanceForType()
Returns
Type Description
ConsumerQuotaMetric

getDescendantConsumerQuotaLimits(int index)

public ConsumerQuotaLimit getDescendantConsumerQuotaLimits(int index)

The quota limits targeting the descendant containers of the consumer in request.

If the consumer in request is of type organizations or folders, the field will list per-project limits in the metric; if the consumer in request is of type project, the field will be empty.

The quota_buckets field of each descendant consumer quota limit will not be populated.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit descendant_consumer_quota_limits = 6;

Parameter
Name Description
index int
Returns
Type Description
ConsumerQuotaLimit

getDescendantConsumerQuotaLimitsCount()

public int getDescendantConsumerQuotaLimitsCount()

The quota limits targeting the descendant containers of the consumer in request.

If the consumer in request is of type organizations or folders, the field will list per-project limits in the metric; if the consumer in request is of type project, the field will be empty.

The quota_buckets field of each descendant consumer quota limit will not be populated.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit descendant_consumer_quota_limits = 6;

Returns
Type Description
int

getDescendantConsumerQuotaLimitsList()

public List<ConsumerQuotaLimit> getDescendantConsumerQuotaLimitsList()

The quota limits targeting the descendant containers of the consumer in request.

If the consumer in request is of type organizations or folders, the field will list per-project limits in the metric; if the consumer in request is of type project, the field will be empty.

The quota_buckets field of each descendant consumer quota limit will not be populated.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit descendant_consumer_quota_limits = 6;

Returns
Type Description
List<ConsumerQuotaLimit>

getDescendantConsumerQuotaLimitsOrBuilder(int index)

public ConsumerQuotaLimitOrBuilder getDescendantConsumerQuotaLimitsOrBuilder(int index)

The quota limits targeting the descendant containers of the consumer in request.

If the consumer in request is of type organizations or folders, the field will list per-project limits in the metric; if the consumer in request is of type project, the field will be empty.

The quota_buckets field of each descendant consumer quota limit will not be populated.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit descendant_consumer_quota_limits = 6;

Parameter
Name Description
index int
Returns
Type Description
ConsumerQuotaLimitOrBuilder

getDescendantConsumerQuotaLimitsOrBuilderList()

public List<? extends ConsumerQuotaLimitOrBuilder> getDescendantConsumerQuotaLimitsOrBuilderList()

The quota limits targeting the descendant containers of the consumer in request.

If the consumer in request is of type organizations or folders, the field will list per-project limits in the metric; if the consumer in request is of type project, the field will be empty.

The quota_buckets field of each descendant consumer quota limit will not be populated.

repeated .google.api.serviceusage.v1beta1.ConsumerQuotaLimit descendant_consumer_quota_limits = 6;

Returns
Type Description
List<? extends com.google.api.serviceusage.v1beta1.ConsumerQuotaLimitOrBuilder>

getDisplayName()

public String getDisplayName()

The display name of the metric.

An example name would be: CPUs

string display_name = 2;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the metric.

An example name would be: CPUs

string display_name = 2;

Returns
Type Description
ByteString

The bytes for displayName.

getMetric()

public String getMetric()

The name of the metric.

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

string metric = 4;

Returns
Type Description
String

The metric.

getMetricBytes()

public ByteString getMetricBytes()

The name of the metric.

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

string metric = 4;

Returns
Type Description
ByteString

The bytes for metric.

getName()

public String getName()

The resource name of the quota settings on this metric for this consumer.

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

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 settings on this metric for this consumer.

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

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<ConsumerQuotaMetric> getParserForType()
Returns
Type Description
Parser<ConsumerQuotaMetric>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getUnit()

public String getUnit()

The units in which the metric value is reported.

string unit = 5;

Returns
Type Description
String

The unit.

getUnitBytes()

public ByteString getUnitBytes()

The units in which the metric value is reported.

string unit = 5;

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 ConsumerQuotaMetric.Builder newBuilderForType()
Returns
Type Description
ConsumerQuotaMetric.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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