Reference documentation and code samples for the Google Cloud Quotas V1 Client class QuotaInfo.
QuotaInfo represents information about a particular quota for a given project, folder or organization.
Generated from protobuf message google.api.cloudquotas.v1.QuotaInfo
Namespace
Google \ Cloud \ CloudQuotas \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Resource name of this QuotaInfo. The ID component following "locations/" must be "global". Example: |
↳ quota_id |
string
The id of the quota, which is unquie within the service. Example: |
↳ metric |
string
The metric of the quota. It specifies the resources consumption the quota is defined for. Example: |
↳ service |
string
The name of the service in which the quota is defined. Example: |
↳ is_precise |
bool
Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision. |
↳ refresh_interval |
string
The reset time interval for the quota. Refresh interval applies to rate quota only. Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds. |
↳ container_type |
int
The container type of the QuotaInfo. |
↳ dimensions |
array
The dimensions the quota is defined on. |
↳ metric_display_name |
string
The display name of the quota metric |
↳ quota_display_name |
string
The display name of the quota. |
↳ metric_unit |
string
The unit in which the metric value is reported, e.g., "MByte". |
↳ quota_increase_eligibility |
QuotaIncreaseEligibility
Whether it is eligible to request a higher quota value for this quota. |
↳ is_fixed |
bool
Whether the quota value is fixed or adjustable |
↳ dimensions_infos |
array<DimensionsInfo>
The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones. |
↳ is_concurrent |
bool
Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time. |
↳ service_request_quota_uri |
string
URI to the page where users can request more quota for the cloud service—for example, https://console.cloud.google.com/iam-admin/quotas. |
getName
Resource name of this QuotaInfo.
The ID component following "locations/" must be "global".
Example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
| Returns | |
|---|---|
| Type | Description |
string |
|
setName
Resource name of this QuotaInfo.
The ID component following "locations/" must be "global".
Example:
projects/123/locations/global/services/compute.googleapis.com/quotaInfos/CpusPerProjectPerRegion
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuotaId
The id of the quota, which is unquie within the service.
Example: CpusPerProjectPerRegion
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuotaId
The id of the quota, which is unquie within the service.
Example: CpusPerProjectPerRegion
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetric
The metric of the quota. It specifies the resources consumption the quota is defined for.
Example: compute.googleapis.com/cpus
| Returns | |
|---|---|
| Type | Description |
string |
|
setMetric
The metric of the quota. It specifies the resources consumption the quota is defined for.
Example: compute.googleapis.com/cpus
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getService
The name of the service in which the quota is defined.
Example: compute.googleapis.com
| Returns | |
|---|---|
| Type | Description |
string |
|
setService
The name of the service in which the quota is defined.
Example: compute.googleapis.com
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsPrecise
Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsPrecise
Whether this is a precise quota. A precise quota is tracked with absolute precision. In contrast, an imprecise quota is not tracked with precision.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRefreshInterval
The reset time interval for the quota. Refresh interval applies to rate quota only.
Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
| Returns | |
|---|---|
| Type | Description |
string |
|
setRefreshInterval
The reset time interval for the quota. Refresh interval applies to rate quota only.
Example: "minute" for per minute, "day" for per day, or "10 seconds" for every 10 seconds.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getContainerType
The container type of the QuotaInfo.
| Returns | |
|---|---|
| Type | Description |
int |
|
setContainerType
The container type of the QuotaInfo.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDimensions
The dimensions the quota is defined on.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDimensions
The dimensions the quota is defined on.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetricDisplayName
The display name of the quota metric
| Returns | |
|---|---|
| Type | Description |
string |
|
setMetricDisplayName
The display name of the quota metric
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuotaDisplayName
The display name of the quota.
| Returns | |
|---|---|
| Type | Description |
string |
|
setQuotaDisplayName
The display name of the quota.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMetricUnit
The unit in which the metric value is reported, e.g., "MByte".
| Returns | |
|---|---|
| Type | Description |
string |
|
setMetricUnit
The unit in which the metric value is reported, e.g., "MByte".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuotaIncreaseEligibility
Whether it is eligible to request a higher quota value for this quota.
| Returns | |
|---|---|
| Type | Description |
QuotaIncreaseEligibility|null |
|
hasQuotaIncreaseEligibility
clearQuotaIncreaseEligibility
setQuotaIncreaseEligibility
Whether it is eligible to request a higher quota value for this quota.
| Parameter | |
|---|---|
| Name | Description |
var |
QuotaIncreaseEligibility
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsFixed
Whether the quota value is fixed or adjustable
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsFixed
Whether the quota value is fixed or adjustable
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDimensionsInfos
The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDimensionsInfos
The collection of dimensions info ordered by their dimensions from more specific ones to less specific ones.
| Parameter | |
|---|---|
| Name | Description |
var |
array<DimensionsInfo>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getIsConcurrent
Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setIsConcurrent
Whether the quota is a concurrent quota. Concurrent quotas are enforced on the total number of concurrent operations in flight at any given time.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getServiceRequestQuotaUri
URI to the page where users can request more quota for the cloud service—for example, https://console.cloud.google.com/iam-admin/quotas.
| Returns | |
|---|---|
| Type | Description |
string |
|
setServiceRequestQuotaUri
URI to the page where users can request more quota for the cloud service—for example, https://console.cloud.google.com/iam-admin/quotas.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|