Google Cloud Quotas V1 Client - Class QuotaConfig (0.1.0)

Reference documentation and code samples for the Google Cloud Quotas V1 Client class QuotaConfig.

The preferred quota configuration.

Generated from protobuf message google.api.cloudquotas.v1.QuotaConfig

Namespace

Google \ Cloud \ CloudQuotas \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ preferred_value int|string

Required. The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".

↳ state_detail string

Output only. Optional details about the state of this quota preference.

↳ granted_value Google\Protobuf\Int64Value

Output only. Granted quota value.

↳ trace_id string

Output only. The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.

↳ annotations array|Google\Protobuf\Internal\MapField

The annotations map for clients to store small amounts of arbitrary data. Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

↳ request_origin int

Output only. The origin of the quota preference request.

getPreferredValue

Required. The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".

Returns
TypeDescription
int|string

setPreferredValue

Required. The preferred value. Must be greater than or equal to -1. If set to -1, it means the value is "unlimited".

Parameter
NameDescription
var int|string
Returns
TypeDescription
$this

getStateDetail

Output only. Optional details about the state of this quota preference.

Returns
TypeDescription
string

setStateDetail

Output only. Optional details about the state of this quota preference.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getGrantedValue

Output only. Granted quota value.

Returns
TypeDescription
Google\Protobuf\Int64Value|null

hasGrantedValue

clearGrantedValue

getGrantedValueUnwrapped

Returns the unboxed value from getGrantedValue()

Output only. Granted quota value.

Returns
TypeDescription
int|string|null

setGrantedValue

Output only. Granted quota value.

Parameter
NameDescription
var Google\Protobuf\Int64Value
Returns
TypeDescription
$this

setGrantedValueUnwrapped

Sets the field by wrapping a primitive type in a Google\Protobuf\Int64Value object.

Output only. Granted quota value.

Parameter
NameDescription
var int|string|null
Returns
TypeDescription
$this

getTraceId

Output only. The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.

Returns
TypeDescription
string

setTraceId

Output only. The trace id that the Google Cloud uses to provision the requested quota. This trace id may be used by the client to contact Cloud support to track the state of a quota preference request. The trace id is only produced for increase requests and is unique for each request. The quota decrease requests do not have a trace id.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getAnnotations

The annotations map for clients to store small amounts of arbitrary data.

Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

Returns
TypeDescription
Google\Protobuf\Internal\MapField

setAnnotations

The annotations map for clients to store small amounts of arbitrary data.

Do not put PII or other sensitive information here. See https://google.aip.dev/128#annotations

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

getRequestOrigin

Output only. The origin of the quota preference request.

Returns
TypeDescription
int

setRequestOrigin

Output only. The origin of the quota preference request.

Parameter
NameDescription
var int
Returns
TypeDescription
$this