Aggregated List

5 variables

29 variables

Retrieves an aggregated list of node groups. Note: use nodeGroups.listNodes for more details about each group

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 29 output parameters

Name	Format	Description
`id`	`STRING`	[Output Only] Unique identifier for the resource; defined by the server
`items`	`OBJECT`	A list of NodeGroupsScopedList resources
`items.customKey`	`OBJECT`	Add additional named properties
`items.customKey.nodeGroups[]`	`OBJECT`	Represent a sole-tenant Node Group resource. A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15
`items.customKey.nodeGroups[].creationTimestamp`	`STRING`	[Output Only] Creation timestamp in RFC3339 text format
`items.customKey.nodeGroups[].description`	`STRING`	An optional description of this resource. Provide this property when you create the resource
`items.customKey.nodeGroups[].id`	`INTEGER`	[Output Only] The unique identifier for the resource. This identifier is defined by the server
`items.customKey.nodeGroups[].kind`	`STRING`	[Output Only] The type of the resource. Always compute#nodeGroup for node group
`items.customKey.nodeGroups[].name`	`STRING`	The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash
`items.customKey.nodeGroups[].nodeTemplate`	`STRING`	The URL of the node template to which this node group belongs
`items.customKey.nodeGroups[].selfLink`	`STRING`	[Output Only] Server-defined URL for the resource
`items.customKey.nodeGroups[].size`	`INTEGER`	[Output Only] The total number of nodes in the node group
`items.customKey.nodeGroups[].status`	`ENUMERATION`
`items.customKey.nodeGroups[].zone`	`STRING`	[Output Only] The name of the zone where the node group resides, such as us-central1-a
`items.customKey.warning`	`OBJECT`	[Output Only] An informational warning that appears when the nodeGroup list is empty
`items.customKey.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
`items.customKey.warning.data[]`	`OBJECT`
`items.customKey.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)
`items.customKey.warning.data[].value`	`STRING`	[Output Only] A warning data value corresponding to the key
`items.customKey.warning.message`	`STRING`	[Output Only] A human-readable description of the warning code
`kind`	`STRING`	[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups
`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

A list of NodeGroupsScopedList resources

items.customKey OBJECT

Add additional named properties

items.customKey.nodeGroups[] OBJECT

Represent a sole-tenant Node Group resource.

A sole-tenant node is a physical server that is dedicated to hosting VM instances only for your specific project. Use sole-tenant nodes to keep your instances physically separated from instances in other projects, or to group your instances together on the same host hardware. For more information, read Sole-tenant nodes. (== resource_for beta.nodeGroups ==) (== resource_for v1.nodeGroups ==) NextID: 15

items.customKey.nodeGroups[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items.customKey.nodeGroups[].description STRING

An optional description of this resource. Provide this property when you create the resource

items.customKey.nodeGroups[].id INTEGER

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

items.customKey.nodeGroups[].kind STRING

[Output Only] The type of the resource. Always compute#nodeGroup for node group

items.customKey.nodeGroups[].name STRING

The name of the resource, provided by the client when initially creating the resource. The resource name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash

items.customKey.nodeGroups[].nodeTemplate STRING

The URL of the node template to which this node group belongs

items.customKey.nodeGroups[].selfLink STRING

[Output Only] Server-defined URL for the resource

items.customKey.nodeGroups[].size INTEGER

[Output Only] The total number of nodes in the node group

items.customKey.nodeGroups[].status ENUMERATION

items.customKey.nodeGroups[].zone STRING

[Output Only] The name of the zone where the node group resides, such as us-central1-a

items.customKey.warning OBJECT

[Output Only] An informational warning that appears when the nodeGroup list is empty

items.customKey.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

items.customKey.warning.data[] OBJECT

items.customKey.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)

items.customKey.warning.data[].value STRING

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

items.customKey.warning.message STRING

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

kind STRING

[Output Only] Type of resource.Always compute#nodeGroupAggregatedList for aggregated lists of node groups

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

warning.data[].value STRING