Google Cloud Quotas V1 Client - Class DimensionsInfo (0.2.3)

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

The detailed quota information such as effective quota value for a combination of dimensions.

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

Namespace

Google \ Cloud \ CloudQuotas \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ dimensions array|Google\Protobuf\Internal\MapField

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value. Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

↳ details Google\Cloud\CloudQuotas\V1\QuotaDetails

Quota details for the specified dimensions.

↳ applicable_locations array

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone. Otherwise, it will be set to the list of locations this dimension info is applicable to.

getDimensions

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value.

Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

Returns
Type Description
Google\Protobuf\Internal\MapField

setDimensions

The map of dimensions for this dimensions info. The key of a map entry is "region", "zone" or the name of a service specific dimension, and the value of a map entry is the value of the dimension. If a dimension does not appear in the map of dimensions, the dimensions info applies to all the dimension values except for those that have another DimenisonInfo instance configured for the specific value.

Example: {"provider" : "Foo Inc"} where "provider" is a service specific dimension of a quota.

Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this

getDetails

Quota details for the specified dimensions.

Returns
Type Description
Google\Cloud\CloudQuotas\V1\QuotaDetails|null

hasDetails

clearDetails

setDetails

Quota details for the specified dimensions.

Parameter
Name Description
var Google\Cloud\CloudQuotas\V1\QuotaDetails
Returns
Type Description
$this

getApplicableLocations

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone.

Otherwise, it will be set to the list of locations this dimension info is applicable to.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setApplicableLocations

The applicable regions or zones of this dimensions info. The field will be set to ['global'] for quotas that are not per region or per zone.

Otherwise, it will be set to the list of locations this dimension info is applicable to.

Parameter
Name Description
var string[]
Returns
Type Description
$this