Aggregated List

Retrieves an aggregated list of all operations

5 variables
42 variables

Retrieves an aggregated list of all operations

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

  = 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 42 output parameters

  = Parameter name
  = Format

id STRING

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

items OBJECT

[Output Only] A map of scoped operation lists

items.customKey OBJECT

Add additional named properties

items.customKey.operations[] OBJECT

Represents an Operation resource.

You can use an operation resource to manage asynchronous API requests. For more information, read Handling API responses.

Operations can be global, regional or zonal.

  • For global operations, use the globalOperations resource.
  • For regional operations, use the regionOperations resource.
  • For zonal operations, use the zonalOperations resource.

For more information, read Global, Regional, and Zonal Resources. (== resource_for v1.globalOperations ==) (== resource_for beta.globalOperations ==) (== resource_for v1.regionOperations ==) (== resource_for beta.regionOperations ==) (== resource_for v1.zoneOperations ==) (== resource_for beta.zoneOperations ==)

items.customKey.operations[].clientOperationId STRING

[Output Only] The value of requestId if you provided it in the request. Not present otherwise

items.customKey.operations[].creationTimestamp STRING

[Deprecated] This field is deprecated

items.customKey.operations[].description STRING

[Output Only] A textual description of the operation, which is set when the operation is created

items.customKey.operations[].endTime STRING

[Output Only] The time that this operation was completed. This value is in RFC3339 text format

items.customKey.operations[].error OBJECT

[Output Only] If errors are generated during processing of the operation, this field will be populated

items.customKey.operations[].httpErrorMessage STRING

[Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as NOT FOUND

items.customKey.operations[].httpErrorStatusCode INTEGER

[Output Only] If the operation fails, this field contains the HTTP error status code that was returned. For example, a 404 means the resource was not found

items.customKey.operations[].id INTEGER

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

items.customKey.operations[].insertTime STRING

[Output Only] The time that this operation was requested. This value is in RFC3339 text format

items.customKey.operations[].kind STRING

[Output Only] Type of the resource. Always compute#operation for Operation resources

items.customKey.operations[].name STRING

[Output Only] Name of the resource

items.customKey.operations[].operationType STRING

[Output Only] The type of operation, such as insert, update, or delete, and so on

items.customKey.operations[].progress INTEGER

[Output Only] An optional progress indicator that ranges from 0 to 100. There is no requirement that this be linear or support any granularity of operations. This should not be used to guess when the operation will be complete. This number should monotonically increase as the operation progresses

items.customKey.operations[].region STRING

[Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations

items.customKey.operations[].selfLink STRING

[Output Only] Server-defined URL for the resource

items.customKey.operations[].startTime STRING

[Output Only] The time that this operation was started by the server. This value is in RFC3339 text format

items.customKey.operations[].status ENUMERATION

[Output Only] The status of the operation, which can be one of the following: PENDING, RUNNING, or DONE

items.customKey.operations[].statusMessage STRING

[Output Only] An optional textual description of the current status of the operation

items.customKey.operations[].targetId INTEGER

[Output Only] The unique target ID, which identifies a specific incarnation of the target resource

items.customKey.operations[].targetLink STRING

[Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the persistent disk that the snapshot was created from

items.customKey.operations[].user STRING

[Output Only] User who requested the operation, for example: [email protected]

items.customKey.operations[].warnings[] OBJECT

items.customKey.operations[].zone STRING

[Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations

items.customKey.warning OBJECT

[Output Only] Informational warning which replaces the list of operations when the 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#operationAggregatedList for aggregated lists of operations

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