Get

Returns the specified commitment resource

3 variables
33 variables

Returns the specified commitment resource. Gets a list of available commitments by making a list() request

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 3 input parameters

  = Parameter name
  = Format

project STRING Required

Project ID for this request

region STRING Required

Name of the region for this request

commitment STRING Required

Name of the commitment to return

Output

This building block provides 33 output parameters

  = Parameter name
  = Format

creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

description STRING

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

endTimestamp STRING

[Output Only] Commitment end time in RFC3339 text format

id INTEGER

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

kind STRING

[Output Only] Type of the resource. Always compute#commitment for 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

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)

region STRING

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

reservations[] OBJECT

Reservation resource NextID: 13

reservations[].commitment STRING

[OutputOnly] Full or partial url for parent commitment for reservations which are tied to a commitment

reservations[].creationTimestamp STRING

[Output Only] Creation timestamp in RFC3339 text format

reservations[].description STRING

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

reservations[].id INTEGER

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

reservations[].kind STRING

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

reservations[].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

reservations[].selfLink STRING

[Output Only] Server-defined fully-qualified URL for this resource

reservations[].specificReservation OBJECT

This reservation type allows to pre allocate specific instance configuration

reservations[].specificReservation.count INTEGER

Specifies number of resources that are allocated

reservations[].specificReservation.inUseCount INTEGER

[OutputOnly] Indicates how many resource are in use

reservations[].specificReservation.instanceProperties OBJECT

Properties of the SKU instances being reserved

reservations[].specificReservation.instanceProperties.machineType STRING

Specifies type of machine (name only) which has fixed number of vCPUs and fixed amount of memory. This also includes specifying custom machine type following custom-NUMBER_OF_CPUS-AMOUNT_OF_MEMORY pattern

reservations[].specificReservation.instanceProperties.minCpuPlatform STRING

Minimum cpu platform the reservation

reservations[].specificReservationRequired BOOLEAN

Indicates whether the reservation can be consumed by VMs with "any reservation" defined. If the field is set, then only VMs that target the reservation by name using --reservation-affinity can consume this reservation

reservations[].status ENUMERATION

[Output Only] The status of the reservation

reservations[].zone STRING

Zone in which the reservation resides, must be provided if reservation is created with commitment creation

resources[] OBJECT

Commitment for a particular resource (a Commitment is composed of one or more of these)

resources[].acceleratorType STRING

Name of the accelerator type resource. Applicable only when the type is ACCELERATOR

resources[].amount INTEGER

The amount of the resource purchased (in a type-dependent unit, such as bytes). For vCPUs, this can just be an integer. For memory, this must be provided in MB. Memory must be a multiple of 256 MB, with up to 6.5GB of memory per every vCPU

resources[].type ENUMERATION

Type of resource for which this commitment applies. Possible values are VCPU and MEMORY

selfLink STRING

[Output Only] Server-defined URL for the resource

startTimestamp STRING

[Output Only] Commitment start time in RFC3339 text format

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

statusMessage STRING

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