com.google.api.servicecontrol.v1

Interface QuotaOperationOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

QuotaOperation, QuotaOperation.Builder

public interface QuotaOperationOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(java.lang.String key) Labels describing the operation.
java.lang.String	getConsumerId() Identity of the consumer for whom this quota operation is being performed.
com.google.protobuf.ByteString	getConsumerIdBytes() Identity of the consumer for whom this quota operation is being performed.
java.util.Map<java.lang.String,java.lang.String>	getLabels() Deprecated.
int	getLabelsCount() Labels describing the operation.
java.util.Map<java.lang.String,java.lang.String>	getLabelsMap() Labels describing the operation.
java.lang.String	getLabelsOrDefault(java.lang.String key, java.lang.String defaultValue) Labels describing the operation.
java.lang.String	getLabelsOrThrow(java.lang.String key) Labels describing the operation.
java.lang.String	getMethodName() Fully qualified name of the API method for which this quota operation is requested.
com.google.protobuf.ByteString	getMethodNameBytes() Fully qualified name of the API method for which this quota operation is requested.
java.lang.String	getOperationId() Identity of the operation.
com.google.protobuf.ByteString	getOperationIdBytes() Identity of the operation.
MetricValueSet	getQuotaMetrics(int index) Represents information about this operation.
int	getQuotaMetricsCount() Represents information about this operation.
java.util.List<MetricValueSet>	getQuotaMetricsList() Represents information about this operation.
MetricValueSetOrBuilder	getQuotaMetricsOrBuilder(int index) Represents information about this operation.
java.util.List<? extends MetricValueSetOrBuilder>	getQuotaMetricsOrBuilderList() Represents information about this operation.
QuotaOperation.QuotaMode	getQuotaMode() Quota mode for this operation.
int	getQuotaModeValue() Quota mode for this operation.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getOperationId

java.lang.String getOperationId()

 Identity of the operation. This must be unique within the scope of the
 service that generated the operation. If the service calls AllocateQuota
 and ReleaseQuota on the same operation, the two calls should carry the
 same ID.
 UUID version 4 is recommended, though not required. In scenarios where an
 operation is computed from existing information and an idempotent id is
 desirable for deduplication purpose, UUID version 5 is recommended. See
 RFC 4122 for details.
 

optional string operation_id = 1;

getOperationIdBytes

com.google.protobuf.ByteString getOperationIdBytes()

 Identity of the operation. This must be unique within the scope of the
 service that generated the operation. If the service calls AllocateQuota
 and ReleaseQuota on the same operation, the two calls should carry the
 same ID.
 UUID version 4 is recommended, though not required. In scenarios where an
 operation is computed from existing information and an idempotent id is
 desirable for deduplication purpose, UUID version 5 is recommended. See
 RFC 4122 for details.
 

optional string operation_id = 1;

getMethodName

java.lang.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 is not
 required if the quota operation is performed on non-API resources.
 Example of an RPC method name:
     google.example.library.v1.LibraryService.CreateShelf
 

optional string method_name = 2;

getMethodNameBytes

com.google.protobuf.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 is not
 required if the quota operation is performed on non-API resources.
 Example of an RPC method name:
     google.example.library.v1.LibraryService.CreateShelf
 

optional string method_name = 2;

getConsumerId

java.lang.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>.
 (--GOOGLE_INTERNAL:
   spatula_header:<spatula_header> and
   loas:<loas_role> are also accepted.
 --)
 

optional string consumer_id = 3;

getConsumerIdBytes

com.google.protobuf.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>.
 (--GOOGLE_INTERNAL:
   spatula_header:<spatula_header> and
   loas:<loas_role> are also accepted.
 --)
 

optional string consumer_id = 3;

getLabelsCount

int getLabelsCount()

 Labels describing the operation.
 

map<string, string> labels = 4;

containsLabels

boolean containsLabels(java.lang.String key)

 Labels describing the operation.
 

map<string, string> labels = 4;

getLabels

@Deprecated
java.util.Map<java.lang.String,java.lang.String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

java.util.Map<java.lang.String,java.lang.String> getLabelsMap()

 Labels describing the operation.
 

map<string, string> labels = 4;

getLabelsOrDefault

java.lang.String getLabelsOrDefault(java.lang.String key,
                                    java.lang.String defaultValue)

 Labels describing the operation.
 

map<string, string> labels = 4;

getLabelsOrThrow

java.lang.String getLabelsOrThrow(java.lang.String key)

 Labels describing the operation.
 

map<string, string> labels = 4;

getQuotaMetricsList

java.util.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.
 

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

getQuotaMetrics

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.
 

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

getQuotaMetricsCount

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.
 

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

getQuotaMetricsOrBuilderList

java.util.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.
 

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

getQuotaMetricsOrBuilder

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.
 

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

getQuotaModeValue

int getQuotaModeValue()

 Quota mode for this operation.
 

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

getQuotaMode

QuotaOperation.QuotaMode getQuotaMode()

 Quota mode for this operation.
 

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