Google Cloud Service Control V1 Client - Class QuotaMode (2.0.0-RC1)

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

Supported quota modes.

Protobuf type google.api.servicecontrol.v1.QuotaOperation.QuotaMode

Namespace

Google \ Cloud \ ServiceControl \ V1 \ QuotaOperation

Methods

static::name

Parameter
Name Description
value mixed

static::value

Parameter
Name Description
name mixed

Constants

UNSPECIFIED

Value: 0

Guard against implicit default. Must not be used.

Generated from protobuf enum UNSPECIFIED = 0;

NORMAL

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

Generated from protobuf enum NORMAL = 1;

BEST_EFFORT

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

Generated from protobuf enum BEST_EFFORT = 2;

CHECK_ONLY

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

Generated from protobuf enum CHECK_ONLY = 3;

QUERY_ONLY

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

Generated from protobuf enum QUERY_ONLY = 4;

ADJUST_ONLY

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

Generated from protobuf enum ADJUST_ONLY = 5;