List

5 variables

30 variables

Retrieves the list of region resources available to the specified project

Authorization

To use this building block you will have to grant access to at least one of the following scopes:

View and manage your data across Google Cloud Platform services
View and manage your Google Compute Engine resources
View your Google Compute Engine resources

Input

This building block consumes 5 input parameters

Name	Format	Description
`project` Required	`STRING`	Project ID for this request
`filter`	`STRING`	A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <. For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance. You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels. To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)
`maxResults`	`INTEGER`	The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)
`orderBy`	`STRING`	Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name. You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first. Currently, only sorting by name or creationTimestamp desc is supported
`pageToken`	`STRING`	Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results

= Parameter name
= Format

project STRING Required

Project ID for this request

filter STRING

A filter expression that filters resources listed in the response. The expression must specify the field name, a comparison operator, and the value that you want to use for filtering. The value must be a string, a number, or a boolean. The comparison operator must be either =, !=, >, or <.

For example, if you are filtering Compute Engine instances, you can exclude instances named example-instance by specifying name != example-instance.

You can also filter nested fields. For example, you could specify scheduling.automaticRestart = false to include instances only if they are not scheduled for automatic restarts. You can use filtering on nested fields to filter based on resource labels.

To filter on multiple expressions, provide each separate expression within parentheses. For example, (scheduling.automaticRestart = true) (cpuPlatform = "Intel Skylake"). By default, each expression is an AND expression. However, you can include AND and OR expressions explicitly. For example, (cpuPlatform = "Intel Skylake") OR (cpuPlatform = "Intel Broadwell") AND (scheduling.automaticRestart = true)

maxResults INTEGER

The maximum number of results per page that should be returned. If the number of available results is larger than maxResults, Compute Engine returns a nextPageToken that can be used to get the next page of results in subsequent list requests. Acceptable values are 0 to 500, inclusive. (Default: 500)

orderBy STRING

Sorts list results by a certain order. By default, results are returned in alphanumerical order based on the resource name.

You can also sort results in descending order based on the creation timestamp using orderBy="creationTimestamp desc". This sorts results based on the creationTimestamp field in reverse chronological order (newest result first). Use this to sort resources like operations so that the newest operation is returned first.

Currently, only sorting by name or creationTimestamp desc is supported

pageToken STRING

Specifies a page token to use. Set pageToken to the nextPageToken returned by a previous list request to get the next page of results

Output

This building block provides 30 output parameters

Name	Format	Description
`id`	`STRING`	[Output Only] Unique identifier for the resource; defined by the server
`items[]`	`OBJECT`	Represents a Region resource. A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==)
`items[].creationTimestamp`	`STRING`	[Output Only] Creation timestamp in RFC3339 text format
`items[].deprecated`	`OBJECT`	Deprecation status for a public resource
`items[].deprecated.deleted`	`STRING`	An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it
`items[].deprecated.deprecated`	`STRING`	An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it
`items[].deprecated.obsolete`	`STRING`	An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it
`items[].deprecated.replacement`	`STRING`	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
`items[].deprecated.state`	`ENUMERATION`	The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error
`items[].description`	`STRING`	[Output Only] Textual description of the resource
`items[].id`	`INTEGER`	[Output Only] The unique identifier for the resource. This identifier is defined by the server
`items[].kind`	`STRING`	[Output Only] Type of the resource. Always compute#region for regions
`items[].name`	`STRING`	[Output Only] Name of the resource
`items[].quotas[]`	`OBJECT`	A quotas entry
`items[].quotas[].limit`	`NUMBER`	[Output Only] Quota limit for this metric
`items[].quotas[].metric`	`ENUMERATION`	[Output Only] Name of the quota metric
`items[].quotas[].owner`	`STRING`	[Output Only] Owning resource. This is the resource on which this quota is applied
`items[].quotas[].usage`	`NUMBER`	[Output Only] Current usage of this metric
`items[].selfLink`	`STRING`	[Output Only] Server-defined URL for the resource
`items[].status`	`ENUMERATION`	[Output Only] Status of the region, either UP or DOWN
`items[].zones[]`	`STRING`
`kind`	`STRING`	[Output Only] Type of resource. Always compute#regionList for lists of regions
`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 than maxResults, 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] Server-defined URL for this resource
`warning`	`OBJECT`	[Output Only] Informational warning message
`warning.code`	`ENUMERATION`	[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response
`warning.data[]`	`OBJECT`
`warning.data[].key`	`STRING`	[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)
`warning.data[].value`	`STRING`	[Output Only] A warning data value corresponding to the key
`warning.message`	`STRING`	[Output Only] A human-readable description of the warning code

= Parameter name
= Format

id STRING

[Output Only] Unique identifier for the resource; defined by the server

items[] OBJECT

Represents a Region resource.

A region is a geographical area where a resource is located. For more information, read Regions and Zones. (== resource_for beta.regions ==) (== resource_for v1.regions ==)

items[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items[].deprecated OBJECT

Deprecation status for a public resource

items[].deprecated.deleted STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DELETED. This is only informational and the status will not change unless the client explicitly changes it

items[].deprecated.deprecated STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to DEPRECATED. This is only informational and the status will not change unless the client explicitly changes it

items[].deprecated.obsolete STRING

An optional RFC3339 timestamp on or after which the state of this resource is intended to change to OBSOLETE. This is only informational and the status will not change unless the client explicitly changes it

items[].deprecated.replacement STRING

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

items[].deprecated.state ENUMERATION

The deprecation state of this resource. This can be ACTIVE, DEPRECATED, OBSOLETE, or DELETED. Operations which communicate the end of life date for an image, can use ACTIVE. Operations which create a new resource using a DEPRECATED resource will return successfully, but with a warning indicating the deprecated resource and recommending its replacement. Operations which use OBSOLETE or DELETED resources will be rejected and result in an error

items[].description STRING

[Output Only] Textual description of the resource

items[].id INTEGER

[Output Only] The unique identifier for the resource. This identifier is defined by the server

items[].kind STRING

[Output Only] Type of the resource. Always compute#region for regions

items[].name STRING

[Output Only] Name of the resource

items[].quotas[] OBJECT

A quotas entry

items[].quotas[].limit NUMBER

[Output Only] Quota limit for this metric

items[].quotas[].metric ENUMERATION

[Output Only] Name of the quota metric

items[].quotas[].owner STRING

[Output Only] Owning resource. This is the resource on which this quota is applied

items[].quotas[].usage NUMBER

[Output Only] Current usage of this metric

items[].selfLink STRING

[Output Only] Server-defined URL for the resource

items[].status ENUMERATION

[Output Only] Status of the region, either UP or DOWN

items[].zones[] STRING

kind STRING

[Output Only] Type of resource. Always compute#regionList for lists of regions

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 than maxResults, 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] Server-defined URL for this resource

warning OBJECT

[Output Only] Informational warning message

warning.code ENUMERATION

[Output Only] A warning code, if applicable. For example, Compute Engine returns NO_RESULTS_ON_PAGE if there are no results in the response

warning.data[] OBJECT

warning.data[].key STRING

[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 scope and the key value might be the zone name. Other examples might be a key indicating a deprecated resource and a suggested replacement, or a warning about invalid network settings (for example, if an instance attempts to perform IP forwarding but is not enabled for IP forwarding)

warning.data[].value STRING

[Output Only] A warning data value corresponding to the key

warning.message STRING

[Output Only] A human-readable description of the warning code