Class QuotaOperation (1.12.0)

Version latest

• 1.12.1 (latest)
• 1.12.0
• 1.11.1
• 1.10.0
• 1.9.1
• 1.8.1
• 1.7.1
• 1.6.0
• 1.5.3
• 1.4.2
• 1.3.1
• 1.2.1
• 1.1.0
• 1.0.3
• 0.3.0
• 0.2.0
• 0.1.0

QuotaOperation(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents information regarding a quota operation.

Attributes
Name	Description
operation_id	str 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	str 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	str Identity of the consumer for whom this quota operation is being performed. This can be in one of the following formats: project:
labels	MutableMapping[str, str] Labels describing the operation.
quota_metrics	MutableSequence[google.cloud.servicecontrol_v1.types.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	google.cloud.servicecontrol_v1.types.QuotaOperation.QuotaMode Quota mode for this operation.

Classes

LabelsEntry

LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
kwargs	dict Keys and values corresponding to the fields of the message.
mapping	Union[dict, .Message] A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields	Optional(bool) If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

QuotaMode

QuotaMode(value)

Supported quota modes.

Values: UNSPECIFIED (0): Guard against implicit default. Must not be used. NORMAL (1): For AllocateQuota request, allocates quota for the amount specified in the service configuration or specified using the quota metrics. If the amount is higher than the available quota, allocation error will be returned and no quota will be allocated. If multiple quotas are part of the request, and one fails, none of the quotas are allocated or released. BEST_EFFORT (2): The operation allocates quota for the amount specified in the service configuration or specified using the quota metrics. If the amount is higher than the available quota, request does not fail but all available quota will be allocated. For rate quota, BEST_EFFORT will continue to deduct from other groups even if one does not have enough quota. For allocation, it will find the minimum available amount across all groups and deduct that amount from all the affected groups. CHECK_ONLY (3): For AllocateQuota request, only checks if there is enough quota available and does not change the available quota. No lock is placed on the available quota either. QUERY_ONLY (4): Unimplemented. When used in AllocateQuotaRequest, this returns the effective quota limit(s) in the response, and no quota check will be performed. Not supported for other requests, and even for AllocateQuotaRequest, this is currently supported only for allowlisted services. ADJUST_ONLY (5): The operation allocates quota for the amount specified in the service configuration or specified using the quota metrics. If the requested amount is higher than the available quota, request does not fail and remaining quota would become negative (going over the limit). Not supported for Rate Quota.