Resource: Region
Represents a Region resource.
A region is a geographical area where a resource is located. For more information, read Regions and Zones.
JSON representation |
---|
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "status": enum, "zones": [ string ], "quotas": [ { "metric": enum, "limit": number, "usage": number, "owner": string } ], "deprecated": { "state": enum, "replacement": string, "deprecated": string, "obsolete": string, "deleted": string, "stateOverride": { "locationRolloutPolicies": { string: string, ... }, "defaultRolloutTime": string } }, "selfLink": string, "supportsPzs": boolean, "quotaStatusWarning": { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } } |
Fields | |
---|---|
kind |
[Output Only] Type of the resource. Always |
id |
[Output Only] The unique identifier for the resource. This identifier is defined by the server. |
creationTimestamp |
[Output Only] Creation timestamp in RFC3339 text format. |
name |
[Output Only] Name of the resource. |
description |
[Output Only] Textual description of the resource. |
status |
[Output Only] Status of the region, either |
zones[] |
[Output Only] A list of zones available in this region, in the form of resource URLs. |
quotas[] |
[Output Only] Quotas assigned to this region. |
quotas[].metric |
[Output Only] Name of the quota metric. |
quotas[].limit |
[Output Only] Quota limit for this metric. |
quotas[].usage |
[Output Only] Current usage of this metric. |
quotas[].owner |
[Output Only] Owning resource. This is the resource on which this quota is applied. |
deprecated |
[Output Only] The deprecation status associated with this region. |
deprecated.state |
The deprecation state of this resource. This can be |
deprecated.replacement |
The URL of the suggested replacement for a deprecated resource. The suggested replacement resource must be the same kind of resource as the deprecated resource. |
deprecated.deprecated |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.obsolete |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.deleted |
An optional RFC3339 timestamp on or after which the state of this resource is intended to change to |
deprecated.stateOverride |
The rollout policy for this deprecation. This policy is only enforced by image family views. The rollout policy restricts the zones where the associated resource is considered in a deprecated state. When the rollout policy does not include the user specified zone, or if the zone is rolled out, the associated resource is considered in a deprecated state. The rollout policy for this deprecation is read-only, except for allowlisted users. This field might not be configured. To view the latest non-deprecated image in a specific zone, use the |
deprecated.stateOverride.locationRolloutPolicies |
Location based rollout policies to apply to the resource. Currently only zone names are supported and must be represented as valid URLs, like: zones/us-central1-a. The value expects an RFC3339 timestamp on or after which the update is considered rolled out to the specified location. |
deprecated.stateOverride.defaultRolloutTime |
An optional RFC3339 timestamp on or after which the update is considered rolled out to any zone that is not explicitly stated. |
selfLink |
[Output Only] Server-defined URL for the resource. |
supportsPzs |
[Output Only] Reserved for future use. |
quotaStatusWarning |
[Output Only] Warning of fetching the |
quotaStatusWarning.code |
[Output Only] A warning code, if applicable. For example, Compute Engine returns |
quotaStatusWarning.message |
[Output Only] A human-readable description of the warning code. |
quotaStatusWarning.data[] |
[Output Only] Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
quotaStatusWarning.data[].key |
[Output Only] A key that provides more detail on the warning being returned. For example, for warnings where there are no results in a list request for a particular zone, this key might be |
quotaStatusWarning.data[].value |
[Output Only] A warning data value corresponding to the key. |
Methods |
|
---|---|
|
Returns the specified Region resource. |
|
Retrieves the list of region resources available to the specified project. |