Aggregated List

Retrieves an aggregated list of commitments

5 variables
31 variables

Retrieves an aggregated list of commitments

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

  = Parameter name
  = Format

id STRING

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

items OBJECT

A list of CommitmentsScopedList resources

items.customKey OBJECT

Add additional named properties

items.customKey.commitments[] OBJECT

Represents a regional Commitment resource.

Creating a commitment resource means that you are purchasing a committed use contract with an explicit start and end time. You can create commitments based on vCPUs and memory usage and receive discounted rates. For full details, read Signing Up for Committed Use Discounts. (== resource_for beta.regionCommitments ==) (== resource_for v1.regionCommitments ==)

items.customKey.commitments[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

items.customKey.commitments[].description STRING

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

items.customKey.commitments[].endTimestamp STRING

[Output Only] Commitment end time in RFC3339 text format

items.customKey.commitments[].id INTEGER

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

items.customKey.commitments[].kind STRING

[Output Only] Type of the resource. Always compute#commitment for commitments

items.customKey.commitments[].name STRING

Name of the resource. Provided by the client when the resource is created. The 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.commitments[].plan ENUMERATION

The plan for this commitment, which determines duration and discount rate. The currently supported plans are TWELVE_MONTH (1 year), and THIRTY_SIX_MONTH (3 years)

items.customKey.commitments[].region STRING

[Output Only] URL of the region where this commitment may be used

items.customKey.commitments[].selfLink STRING

[Output Only] Server-defined URL for the resource

items.customKey.commitments[].startTimestamp STRING

[Output Only] Commitment start time in RFC3339 text format

items.customKey.commitments[].status ENUMERATION

[Output Only] Status of the commitment with regards to eventual expiration (each commitment has an end date defined). One of the following values: NOT_YET_ACTIVE, ACTIVE, EXPIRED

items.customKey.commitments[].statusMessage STRING

[Output Only] An optional, human-readable explanation of the status

items.customKey.warning OBJECT

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

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