project STRING Required

Project ID for this request

region STRING Required

Name of the region for this request

requestId STRING

An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000)

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

Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources. (== resource_for beta.reservations ==) (== resource_for v1.reservations ==) (== 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 affinity for "any" reservation. If the field is set, then only VMs that target the reservation by name can consume from 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

clientOperationId STRING

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

creationTimestamp STRING

[Deprecated] This field is deprecated

description STRING

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

endTime STRING

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

error OBJECT

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

error.errors[] OBJECT

error.errors[].code STRING

[Output Only] The error type identifier for this error

error.errors[].location STRING

[Output Only] Indicates the field in the request that caused the error. This property is optional

error.errors[].message STRING

[Output Only] An optional, human-readable error message

httpErrorMessage STRING

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

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

id INTEGER

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

insertTime STRING

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

kind STRING

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

name STRING

[Output Only] Name of the resource

operationType STRING

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

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

region STRING

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

selfLink STRING

[Output Only] Server-defined URL for the resource

startTime STRING

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

status ENUMERATION

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

statusMessage STRING

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

targetId INTEGER

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

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

user STRING

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

warnings[] OBJECT

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

warnings[].data[] OBJECT

warnings[].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)

warnings[].data[].value STRING

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

warnings[].message STRING

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

zone STRING

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