regions

Creates, updates, deletes, gets or lists a regions resource.

Overview

Name	regions
Type	Resource
Id	google.compute.regions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string (uint64)	[Output Only] The unique identifier for the resource. This identifier is defined by the server.
name	string	[Output Only] Name of the resource.
creationTimestamp	string	[Output Only] Creation timestamp inRFC3339 text format.
deprecated	object	[Output Only] The deprecation status associated with this region. (id: DeprecationStatus)
description	string	[Output Only] Textual description of the resource.
kind	string	Output only. [Output Only] Type of the resource. Always compute#region for regions. (default: compute#region)
quotaStatusWarning	object	Output only. [Output Only] Warning of fetching the quotas field for this region. This field is populated only if fetching of the quotas field fails.
quotas	array	[Output Only] Quotas assigned to this region.
selfLink	string	[Output Only] Server-defined URL for the resource.
status	string	[Output Only] Status of the region, either UP orDOWN. (DOWN, UP)
supportsPzs	boolean	Output only. [Output Only] Reserved for future use.
zones	array	[Output Only] A list of zones available in this region, in the form of resource URLs.

list

Name	Datatype	Description
id	string	[Output Only] Unique identifier for the resource; defined by the server.
items	array	A list of Region resources.
kind	string	Output only. [Output Only] Type of resource. Always compute#regionList for lists of regions. (default: compute#regionList)
nextPageToken	string	[Output Only] This token allows you to get the next page of results for list requests. If the number of results is larger thanmaxResults, use the nextPageToken as a value for the query parameter pageToken in the next list request. Subsequent list requests will have their own nextPageToken to continue paging through the results.
selfLink	string	Output only. [Output Only] Server-defined URL for this resource.
warning	object	[Output Only] Informational warning message.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	project, region		Returns the specified Region resource. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the quotas field). To exclude one or more fields, set your request's fields query parameter to only include the fields you need. For example, to only include the id and selfLink fields, add the query parameter ?fields=id,selfLink to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the items.quotas field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.
list	select	project	returnPartialSuccess, orderBy, filter, maxResults, pageToken	Retrieves the list of region resources available to the specified project. To decrease latency for this method, you can optionally omit any unneeded information from the response by using a field mask. This practice is especially recommended for unused quota information (the items.quotas field). To exclude one or more fields, set your request's fields query parameter to only include the fields you need. For example, to only include the id and selfLink fields, add the query parameter ?fields=id,selfLink to your request. This method fails if the quota information is unavailable for the region and if the organization policy constraint compute.requireBasicQuotaInResponse is enforced. This constraint, when enforced, disables the fail-open behaviour when quota information (the items.quotas field) is unavailable for the region. It is recommended to use the default setting for the constraint unless your application requires the fail-closed behaviour for this method.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
project	string
region	string
filter	string
maxResults	integer (uint32)
orderBy	string
pageToken	string
returnPartialSuccess	boolean

SELECT examples

get

Returns the specified Region resource.

To decrease latency for this method, you can optionally omit any unneeded
information from the response by using a field mask. This practice is
especially recommended for unused quota information (the quotas field).
To exclude one or more fields, set your request's fields query parameter
to only include the fields you need. For example, to only include the id
and selfLink fields, add the query parameter ?fields=id,selfLink to
your request.

This method fails if the quota information is unavailable for the region
and if the organization policy constraint
compute.requireBasicQuotaInResponse is enforced. This
constraint, when enforced, disables the fail-open behaviour when quota
information (the items.quotas field) is unavailable for the region.
It is recommended to use the default setting
for the constraint unless your application requires the fail-closed
behaviour for this method.

SELECT
id,
name,
creationTimestamp,
deprecated,
description,
kind,
quotaStatusWarning,
quotas,
selfLink,
status,
supportsPzs,
zones
FROM google.compute.regions
WHERE project = '{{ project }}' -- required
AND region = '{{ region }}' -- required
;

list

Retrieves the list of region resources available to the specified project.

To decrease latency for this method, you can optionally omit any unneeded
information from the response by using a field mask. This practice is
especially recommended for unused quota information
(the items.quotas field).
To exclude one or more fields, set your request's fields query parameter
to only include the fields you need. For example, to only include the id
and selfLink fields, add the query parameter ?fields=id,selfLink to
your request.

This method fails if the quota information is unavailable for the region
and if the organization policy constraint
compute.requireBasicQuotaInResponse is enforced. This
constraint, when enforced, disables the fail-open behaviour when quota
information (the items.quotas field) is unavailable for the region.
It is recommended to use the default setting
for the constraint unless your application requires the fail-closed
behaviour for this method.

SELECT
id,
items,
kind,
nextPageToken,
selfLink,
warning
FROM google.compute.regions
WHERE project = '{{ project }}' -- required
AND returnPartialSuccess = '{{ returnPartialSuccess }}'
AND orderBy = '{{ orderBy }}'
AND filter = '{{ filter }}'
AND maxResults = '{{ maxResults }}'
AND pageToken = '{{ pageToken }}'
;