Google Cloud Service Control V1 Client - Class QuotaOperation (1.2.1)

Reference documentation and code samples for the Google Cloud Service Control V1 Client class QuotaOperation.

Represents information regarding a quota operation.

Generated from protobuf message google.api.servicecontrol.v1.QuotaOperation

Namespace

Google \ Cloud \ ServiceControl \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ operation_id 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

↳ method_name 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

↳ consumer_id string

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

↳ labels array|Google\Protobuf\Internal\MapField

Labels describing the operation.

↳ quota_metrics 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 int

Quota mode for this operation.

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

Returns
TypeDescription
string

setOperationId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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

Returns
TypeDescription
string

setMethodName

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

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

Returns
TypeDescription
string

setConsumerId

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getLabels

Labels describing the operation.

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setLabels

Labels describing the operation.

Parameter
NameDescription
var array|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this

getQuotaMetrics

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
TypeDescription
Google\Protobuf\Internal\RepeatedField

setQuotaMetrics

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.

Parameter
NameDescription
var array<Google\Cloud\ServiceControl\V1\MetricValueSet>
Returns
TypeDescription
$this

getQuotaMode

Quota mode for this operation.

Returns
TypeDescription
int

setQuotaMode

Quota mode for this operation.

Parameter
NameDescription
var int
Returns
TypeDescription
$this