Class QuotaOperation (1.36.0)

public final class QuotaOperation extends GeneratedMessageV3 implements QuotaOperationOrBuilder

Represents information regarding a quota operation.

Protobuf type google.api.servicecontrol.v1.QuotaOperation

Static Fields

CONSUMER_ID_FIELD_NUMBER

public static final int CONSUMER_ID_FIELD_NUMBER
Field Value
TypeDescription
int

LABELS_FIELD_NUMBER

public static final int LABELS_FIELD_NUMBER
Field Value
TypeDescription
int

METHOD_NAME_FIELD_NUMBER

public static final int METHOD_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

OPERATION_ID_FIELD_NUMBER

public static final int OPERATION_ID_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_METRICS_FIELD_NUMBER

public static final int QUOTA_METRICS_FIELD_NUMBER
Field Value
TypeDescription
int

QUOTA_MODE_FIELD_NUMBER

public static final int QUOTA_MODE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static QuotaOperation getDefaultInstance()
Returns
TypeDescription
QuotaOperation

getDescriptor()

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

newBuilder()

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

newBuilder(QuotaOperation prototype)

public static QuotaOperation.Builder newBuilder(QuotaOperation prototype)
Parameter
NameDescription
prototypeQuotaOperation
Returns
TypeDescription
QuotaOperation.Builder

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

containsLabels(String key)

public boolean containsLabels(String key)

Labels describing the operation.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConsumerId()

public String getConsumerId()

Identity of the consumer for whom this quota operation is being performed.

This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>.

string consumer_id = 3;

Returns
TypeDescription
String

The consumerId.

getConsumerIdBytes()

public ByteString getConsumerIdBytes()

Identity of the consumer for whom this quota operation is being performed.

This can be in one of the following formats: project:<project_id>, project_number:<project_number>, api_key:<api_key>.

string consumer_id = 3;

Returns
TypeDescription
ByteString

The bytes for consumerId.

getDefaultInstanceForType()

public QuotaOperation getDefaultInstanceForType()
Returns
TypeDescription
QuotaOperation

getLabels() (deprecated)

public Map<String,String> getLabels()

Use #getLabelsMap() instead.

Returns
TypeDescription
Map<String,String>

getLabelsCount()

public int getLabelsCount()

Labels describing the operation.

map<string, string> labels = 4;

Returns
TypeDescription
int

getLabelsMap()

public Map<String,String> getLabelsMap()

Labels describing the operation.

map<string, string> labels = 4;

Returns
TypeDescription
Map<String,String>

getLabelsOrDefault(String key, String defaultValue)

public String getLabelsOrDefault(String key, String defaultValue)

Labels describing the operation.

map<string, string> labels = 4;

Parameters
NameDescription
keyString
defaultValueString
Returns
TypeDescription
String

getLabelsOrThrow(String key)

public String getLabelsOrThrow(String key)

Labels describing the operation.

map<string, string> labels = 4;

Parameter
NameDescription
keyString
Returns
TypeDescription
String

getMethodName()

public String getMethodName()

Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration.

This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override.

Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf

string method_name = 2;

Returns
TypeDescription
String

The methodName.

getMethodNameBytes()

public ByteString getMethodNameBytes()

Fully qualified name of the API method for which this quota operation is requested. This name is used for matching quota rules or metric rules and billing status rules defined in service configuration.

This field should not be set if any of the following is true: (1) the quota operation is performed on non-API resources. (2) quota_metrics is set because the caller is doing quota override.

Example of an RPC method name: google.example.library.v1.LibraryService.CreateShelf

string method_name = 2;

Returns
TypeDescription
ByteString

The bytes for methodName.

getOperationId()

public String getOperationId()

Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID

string operation_id = 1;

Returns
TypeDescription
String

The operationId.

getOperationIdBytes()

public ByteString getOperationIdBytes()

Identity of the operation. This is expected to be unique within the scope of the service that generated the operation, and guarantees idempotency in case of retries.

In order to ensure best performance and latency in the Quota backends, operation_ids are optimally associated with time, so that related operations can be accessed fast in storage. For this reason, the recommended token for services that intend to operate at a high QPS is Unix time in nanos + UUID

string operation_id = 1;

Returns
TypeDescription
ByteString

The bytes for operationId.

getParserForType()

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

getQuotaMetrics(int index)

public MetricValueSet getQuotaMetrics(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricValueSet

getQuotaMetricsCount()

public int getQuotaMetricsCount()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Returns
TypeDescription
int

getQuotaMetricsList()

public List<MetricValueSet> getQuotaMetricsList()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Returns
TypeDescription
List<MetricValueSet>

getQuotaMetricsOrBuilder(int index)

public MetricValueSetOrBuilder getQuotaMetricsOrBuilder(int index)

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Parameter
NameDescription
indexint
Returns
TypeDescription
MetricValueSetOrBuilder

getQuotaMetricsOrBuilderList()

public List<? extends MetricValueSetOrBuilder> getQuotaMetricsOrBuilderList()

Represents information about this operation. Each MetricValueSet corresponds to a metric defined in the service configuration. The data type used in the MetricValueSet must agree with the data type specified in the metric definition.

Within a single operation, it is not allowed to have more than one MetricValue instances that have the same metric names and identical label value combinations. If a request has such duplicated MetricValue instances, the entire request is rejected with an invalid argument error.

This field is mutually exclusive with method_name.

repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

Returns
TypeDescription
List<? extends com.google.api.servicecontrol.v1.MetricValueSetOrBuilder>

getQuotaMode()

public QuotaOperation.QuotaMode getQuotaMode()

Quota mode for this operation.

.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

Returns
TypeDescription
QuotaOperation.QuotaMode

The quotaMode.

getQuotaModeValue()

public int getQuotaModeValue()

Quota mode for this operation.

.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;

Returns
TypeDescription
int

The enum numeric value on the wire for quotaMode.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
NameDescription
numberint
Returns
TypeDescription
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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