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
LABELS_FIELD_NUMBER
public static final int LABELS_FIELD_NUMBER
Field Value
METHOD_NAME_FIELD_NUMBER
public static final int METHOD_NAME_FIELD_NUMBER
Field Value
OPERATION_ID_FIELD_NUMBER
public static final int OPERATION_ID_FIELD_NUMBER
Field Value
QUOTA_METRICS_FIELD_NUMBER
public static final int QUOTA_METRICS_FIELD_NUMBER
Field Value
QUOTA_MODE_FIELD_NUMBER
public static final int QUOTA_MODE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static QuotaOperation getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static QuotaOperation.Builder newBuilder()
Returns
newBuilder(QuotaOperation prototype)
public static QuotaOperation.Builder newBuilder(QuotaOperation prototype)
Parameter
Returns
public static QuotaOperation parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static QuotaOperation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static QuotaOperation parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QuotaOperation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static QuotaOperation parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QuotaOperation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static QuotaOperation parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static QuotaOperation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static QuotaOperation parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static QuotaOperation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static QuotaOperation parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QuotaOperation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<QuotaOperation> parser()
Returns
Methods
containsLabels(String key)
public boolean containsLabels(String key)
Labels describing the operation.
map<string, string> labels = 4;
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for consumerId.
|
getDefaultInstanceForType()
public QuotaOperation getDefaultInstanceForType()
Returns
getLabels()
public Map<String,String> getLabels()
Returns
getLabelsCount()
public int getLabelsCount()
Labels describing the operation.
map<string, string> labels = 4;
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels describing the operation.
map<string, string> labels = 4;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels describing the operation.
map<string, string> labels = 4;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels describing the operation.
map<string, string> labels = 4;
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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| 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;
| Type | Description |
| ByteString | The bytes for operationId.
|
getParserForType()
public Parser<QuotaOperation> getParserForType()
Returns
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;
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;
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;
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;
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;
| Type | Description |
| 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;
getQuotaModeValue()
public int getQuotaModeValue()
Quota mode for this operation.
.google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;
| Type | Description |
| int | The enum numeric value on the wire for quotaMode.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public QuotaOperation.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QuotaOperation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public QuotaOperation.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
