Service Control API V1 API - Class Google::Cloud::ServiceControl::V1::QuotaOperation (v1.1.0)

Reference documentation and code samples for the Service Control API V1 API class Google::Cloud::ServiceControl::V1::QuotaOperation.

Represents information regarding a quota operation.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#consumer_id

def consumer_id() -> ::String
Returns
  • (::String) — Identity of the consumer for whom this quota operation is being performed.

    This can be in one of the following formats: project:

#consumer_id=

def consumer_id=(value) -> ::String
Parameter
  • value (::String) — Identity of the consumer for whom this quota operation is being performed.

    This can be in one of the following formats: project:

Returns
  • (::String) — Identity of the consumer for whom this quota operation is being performed.

    This can be in one of the following formats: project:

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels describing the operation.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels describing the operation.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels describing the operation.

#method_name

def method_name() -> ::String
Returns
  • (::String) — 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

#method_name=

def method_name=(value) -> ::String
Parameter
  • value (::String) — 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

Returns
  • (::String) — 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

#operation_id

def operation_id() -> ::String
Returns
  • (::String) — 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

#operation_id=

def operation_id=(value) -> ::String
Parameter
  • value (::String) — 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

Returns
  • (::String) — 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

#quota_metrics

def quota_metrics() -> ::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>
Returns
  • (::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>) — 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.

#quota_metrics=

def quota_metrics=(value) -> ::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>
Parameter
  • value (::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>) — 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.

Returns
  • (::Array<::Google::Cloud::ServiceControl::V1::MetricValueSet>) — 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.

#quota_mode

def quota_mode() -> ::Google::Cloud::ServiceControl::V1::QuotaOperation::QuotaMode
Returns

#quota_mode=

def quota_mode=(value) -> ::Google::Cloud::ServiceControl::V1::QuotaOperation::QuotaMode
Parameter
Returns