Reference documentation and code samples for the Google Cloud Quotas V1beta Client class DimensionsInfo.
The detailed quota information such as effective quota value for a combination of dimensions.
Generated from protobuf message google.api.cloudquotas.v1beta.DimensionsInfo
Namespace
Google \ Cloud \ CloudQuotas \ V1betaMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ dimensions |
array|Google\Protobuf\Internal\MapField
The map of dimensions in key-value pairs. 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 DimensionInfo instance configured for the specific value. For example: |
↳ details |
QuotaDetails
Quota details for the specified dimensions. |
↳ applicable_locations |
array
The applicable regions or zones of this dimension. The field is 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 in key-value pairs. 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 DimensionInfo instance configured for the specific value.
For example: {"provider" : "Example Organization"} where provider is a
service-specific quota dimension and Example Organization is the provider
name.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField |
|
setDimensions
The map of dimensions in key-value pairs. 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 DimensionInfo instance configured for the specific value.
For example: {"provider" : "Example Organization"} where provider is a
service-specific quota dimension and Example Organization is the provider
name.
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDetails
Quota details for the specified dimensions.
| Returns | |
|---|---|
| Type | Description |
QuotaDetails|null |
|
hasDetails
clearDetails
setDetails
Quota details for the specified dimensions.
| Parameter | |
|---|---|
| Name | Description |
var |
QuotaDetails
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getApplicableLocations
The applicable regions or zones of this dimension. The field is 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 dimension. The field is 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 |
|