Package 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 Detail

      • getOperationId

        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:
        The operationId.

      • getOperationIdBytes

        com.google.protobuf.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:
        The bytes for operationId.

      • getMethodName

        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:
        The methodName.

      • 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 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:
        The bytes for methodName.

      • getConsumerId

        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:
        The consumerId.

      • 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>.
        string consumer_id = 3;
        Returns:
        The bytes for consumerId.

      • getLabelsCount

        int getLabelsCount()
         Labels describing the operation.
        map<string, string> labels = 4;

      • containsLabels

        boolean containsLabels​(String key)
         Labels describing the operation.
        map<string, string> labels = 4;

      • getLabelsMap

        Map<String,​String> getLabelsMap()
         Labels describing the operation.
        map<string, string> labels = 4;

      • getLabelsOrDefault

        String getLabelsOrDefault​(String key,
                          String defaultValue)
         Labels describing the operation.
        map<string, string> labels = 4;

      • getLabelsOrThrow

        String getLabelsOrThrow​(String key)
         Labels describing the operation.
        map<string, string> labels = 4;

      • getQuotaMetricsList

        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;

      • 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.

 This field is mutually exclusive with method_name.
        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.

 This field is mutually exclusive with method_name.
        repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

      • getQuotaMetricsOrBuilderList

        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;

      • 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.

 This field is mutually exclusive with method_name.
        repeated .google.api.servicecontrol.v1.MetricValueSet quota_metrics = 5;

      • getQuotaModeValue

        int getQuotaModeValue()
         Quota mode for this operation.
        .google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;
        Returns:
        The enum numeric value on the wire for quotaMode.

      • getQuotaMode

        QuotaOperation.QuotaMode getQuotaMode()
         Quota mode for this operation.
        .google.api.servicecontrol.v1.QuotaOperation.QuotaMode quota_mode = 6;
        Returns:
        The quotaMode.