Method: regionCommitments.update

HTTP request
Path parameters
Query parameters
Request body
- JSON representation
Response body
- JSON representation
Authorization scopes
IAM Permissions
Try it!

Updates the specified commitment with the data included in the request. regionCommitments.update is performed only on selected fields included as part of update-mask. Only the following fields can be modified: autoRenew.

HTTP request

PATCH https://compute.googleapis.com/compute/beta/projects/{project}/regions/{region}/commitments/{commitment}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`region`	`string` Name of the region for this request.
`commitment`	`string` Name of the commitment for which auto renew is being updated.

project

string

Project ID for this request.

region

string

Name of the region for this request.

commitment

string

Name of the commitment for which auto renew is being updated.

Query parameters

Parameters

Parameters
`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`).

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

Request body

The request body contains data with the following structure:

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "description": string, "region": string, "selfLink": string, "status": enum, "statusMessage": string, "plan": enum, "startTimestamp": string, "endTimestamp": string, "resources": [ { "type": enum, "amount": string, "acceleratorType": string } ], "type": enum, "reservations": [ { "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "zone": string, "description": string, "name": string, "specificReservation": { "instanceProperties": { "machineType": string, "guestAccelerators": [ { "acceleratorType": string, "acceleratorCount": integer } ], "minCpuPlatform": string, "localSsds": [ { "diskSizeGb": string, "interface": enum } ], "maintenanceFreezeDurationHours": integer, "locationHint": string, "maintenanceInterval": enum }, "count": string, "inUseCount": string, "assuredCount": string, "sourceInstanceTemplate": string }, "aggregateReservation": { "vmFamily": enum, "reservedResources": [ { "accelerator": { "acceleratorCount": integer, "acceleratorType": string } } ], "inUseResources": [ { "accelerator": { "acceleratorCount": integer, "acceleratorType": string } } ], "workloadType": enum }, "commitment": string, "specificReservationRequired": boolean, "status": enum, "shareSettings": { "shareType": enum, "projects": [ string ], "projectMap": { string: { "projectId": string }, ... } }, "satisfiesPzs": boolean, "resourcePolicies": { string: string, ... }, "resourceStatus": { "specificSkuAllocation": { "sourceInstanceTemplateId": string, "utilizations": { string: string, ... } }, "reservationMaintenance": { "upcomingGroupMaintenance": { "type": enum, "canReschedule": boolean, "windowStartTime": string, "windowEndTime": string, "latestWindowStartTime": string, "maintenanceStatus": enum }, "enableOpportunisticMaintenance": boolean, "maintenanceOngoingCount": integer, "maintenancePendingCount": integer, "schedulingType": enum }, "reservationBlockCount": integer }, "deleteAtTime": string, "deleteAfterDuration": { "seconds": string, "nanos": integer }, "reservationSharingPolicy": { "serviceShareType": enum }, "deploymentType": enum, "instanceTerminationAction": enum } ], "category": enum, "licenseResource": { "license": string, "amount": string, "coresPerLicense": string }, "autoRenew": boolean, "mergeSourceCommitments": [ string ], "splitSourceCommitment": string, "resourceStatus": { "customTermEligibilityEndTimestamp": string }, "existingReservations": [ string ], "customEndTimestamp": string }

JSON representation

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "description": string,
  "region": string,
  "selfLink": string,
  "status": enum,
  "statusMessage": string,
  "plan": enum,
  "startTimestamp": string,
  "endTimestamp": string,
  "resources": [
    {
      "type": enum,
      "amount": string,
      "acceleratorType": string
    }
  ],
  "type": enum,
  "reservations": [
    {
      "kind": string,
      "id": string,
      "creationTimestamp": string,
      "selfLink": string,
      "zone": string,
      "description": string,
      "name": string,
      "specificReservation": {
        "instanceProperties": {
          "machineType": string,
          "guestAccelerators": [
            {
              "acceleratorType": string,
              "acceleratorCount": integer
            }
          ],
          "minCpuPlatform": string,
          "localSsds": [
            {
              "diskSizeGb": string,
              "interface": enum
            }
          ],
          "maintenanceFreezeDurationHours": integer,
          "locationHint": string,
          "maintenanceInterval": enum
        },
        "count": string,
        "inUseCount": string,
        "assuredCount": string,
        "sourceInstanceTemplate": string
      },
      "aggregateReservation": {
        "vmFamily": enum,
        "reservedResources": [
          {
            "accelerator": {
              "acceleratorCount": integer,
              "acceleratorType": string
            }
          }
        ],
        "inUseResources": [
          {
            "accelerator": {
              "acceleratorCount": integer,
              "acceleratorType": string
            }
          }
        ],
        "workloadType": enum
      },
      "commitment": string,
      "specificReservationRequired": boolean,
      "status": enum,
      "shareSettings": {
        "shareType": enum,
        "projects": [
          string
        ],
        "projectMap": {
          string: {
            "projectId": string
          },
          ...
        }
      },
      "satisfiesPzs": boolean,
      "resourcePolicies": {
        string: string,
        ...
      },
      "resourceStatus": {
        "specificSkuAllocation": {
          "sourceInstanceTemplateId": string,
          "utilizations": {
            string: string,
            ...
          }
        },
        "reservationMaintenance": {
          "upcomingGroupMaintenance": {
            "type": enum,
            "canReschedule": boolean,
            "windowStartTime": string,
            "windowEndTime": string,
            "latestWindowStartTime": string,
            "maintenanceStatus": enum
          },
          "enableOpportunisticMaintenance": boolean,
          "maintenanceOngoingCount": integer,
          "maintenancePendingCount": integer,
          "schedulingType": enum
        },
        "reservationBlockCount": integer
      },
      "deleteAtTime": string,
      "deleteAfterDuration": {
        "seconds": string,
        "nanos": integer
      },
      "reservationSharingPolicy": {
        "serviceShareType": enum
      },
      "deploymentType": enum,
      "instanceTerminationAction": enum
    }
  ],
  "category": enum,
  "licenseResource": {
    "license": string,
    "amount": string,
    "coresPerLicense": string
  },
  "autoRenew": boolean,
  "mergeSourceCommitments": [
    string
  ],
  "splitSourceCommitment": string,
  "resourceStatus": {
    "customTermEligibilityEndTimestamp": string
  },
  "existingReservations": [
    string
  ],
  "customEndTimestamp": string
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#commitment` for commitments.
`id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`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.
`description`	`string` An optional description of this resource. Provide this property when you create the resource.
`region`	`string` [Output Only] URL of the region where this commitment may be used.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`status`	`enum` [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.
`plan`	`enum` 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).
`startTimestamp`	`string` [Output Only] Commitment start time in RFC3339 text format.
`endTimestamp`	`string` [Output Only] Commitment end time in RFC3339 text format.
`resources[]`	`object` A list of commitment amounts for particular resources. Note that `VCPU` and `MEMORY` resource commitments must occur together.
`resources[].type`	`enum` Type of resource for which this commitment applies. Possible values are `VCPU`, `MEMORY`, `LOCAL_SSD`, and `ACCELERATOR`.
`resources[].amount`	`string (int64 format)` 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[].acceleratorType`	`string` Name of the accelerator type resource. Applicable only when the type is ACCELERATOR.
`type`	`enum` The type of commitment, which affects the discount rate and the eligible resources. Type `MEMORY_OPTIMIZED` specifies a commitment that will only apply to memory optimized machines. Type `ACCELERATOR_OPTIMIZED` specifies a commitment that will only apply to accelerator optimized machines.
`reservations[]`	`object` regionCommitments.list of create-on-create reservations for this commitment.
`reservations[].kind`	`string` [Output Only] Type of the resource. Always `compute#reservations` for reservations.
`reservations[].id`	`string (uint64 format)` [Output Only] The unique identifier for the resource. This identifier is defined by the server.
`reservations[].creationTimestamp`	`string` [Output Only] Creation timestamp in RFC3339 text format.
`reservations[].selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`reservations[].zone`	`string` Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
`reservations[].description`	`string` An optional description of this resource. Provide this property when you create the resource.
`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[].specificReservation`	`object` Reservation for instances with specific machine shapes.
`reservations[].specificReservation.instanceProperties`	`object` The instance properties for the reservation.
`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.guestAccelerators[]`	`object` Specifies accelerator type and count.
`reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorType`	`string` Full or partial URL of the accelerator type resource to attach to this instance. For example: `projects/my-project/zones/us-central1-c/acceleratorTypes/nvidia-tesla-p100` If you are creating an instance template, specify only the accelerator name. See GPUs on Compute Engine for a full list of accelerator types.
`reservations[].specificReservation.instanceProperties.guestAccelerators[].acceleratorCount`	`integer` The number of the guest accelerator cards exposed to this instance.
`reservations[].specificReservation.instanceProperties.minCpuPlatform`	`string` Minimum cpu platform the reservation.
`reservations[].specificReservation.instanceProperties.localSsds[]`	`object` Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
`reservations[].specificReservation.instanceProperties.localSsds[].diskSizeGb`	`string (int64 format)` Specifies the size of the disk in base-2 GB.
`reservations[].specificReservation.instanceProperties.localSsds[].interface`	`enum` Specifies the disk interface to use for attaching this disk, which is either `SCSI` or `NVME`. The default is `SCSI`. For performance characteristics of SCSI over NVMe, see Local SSD performance.
`reservations[].specificReservation.instanceProperties.maintenanceFreezeDurationHours`	`integer` Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
`reservations[].specificReservation.instanceProperties.locationHint`	`string` An opaque location hint used to place the allocation close to other resources. This field is for use by internal tools that use the public API.
`reservations[].specificReservation.instanceProperties.maintenanceInterval`	`enum` Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
`reservations[].specificReservation.count`	`string (int64 format)` Specifies the number of resources that are allocated.
`reservations[].specificReservation.inUseCount`	`string (int64 format)` [Output Only] Indicates how many instances are in use.
`reservations[].specificReservation.assuredCount`	`string (int64 format)` [Output Only] Indicates how many instances are actually usable currently.
`reservations[].specificReservation.sourceInstanceTemplate`	`string` Specifies the instance template to create the reservation. If you use this field, you must exclude the `instanceProperties` field. This field is optional, and it can be a full or partial URL. For example, the following are all valid URLs to an instance template: `https://www.googleapis.com/compute/v1/projects/project/global/instanceTemplates/instanceTemplate` `projects/project/global/instanceTemplates/instanceTemplate` `global/instanceTemplates/instanceTemplate`
`reservations[].aggregateReservation`	`object` Reservation for aggregated resources, providing shape flexibility.
`reservations[].aggregateReservation.vmFamily`	`enum` The VM family that all instances scheduled against this reservation must belong to.
`reservations[].aggregateReservation.reservedResources[]`	`object` regionCommitments.list of reserved resources (CPUs, memory, accelerators).
`reservations[].aggregateReservation.reservedResources[].accelerator`	`object` Properties of accelerator resources in this reservation.
`reservations[].aggregateReservation.reservedResources[].accelerator.acceleratorCount`	`integer` Number of accelerators of specified type.
`reservations[].aggregateReservation.reservedResources[].accelerator.acceleratorType`	`string` Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
`reservations[].aggregateReservation.inUseResources[]`	`object` [Output only] regionCommitments.list of resources currently in use.
`reservations[].aggregateReservation.inUseResources[].accelerator`	`object` Properties of accelerator resources in this reservation.
`reservations[].aggregateReservation.inUseResources[].accelerator.acceleratorCount`	`integer` Number of accelerators of specified type.
`reservations[].aggregateReservation.inUseResources[].accelerator.acceleratorType`	`string` Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
`reservations[].aggregateReservation.workloadType`	`enum` The workload type of the instances that will target this reservation.
`reservations[].commitment`	`string` [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
`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`	`enum` [Output Only] The status of the reservation. `CREATING`: Reservation resources are being allocated. `READY`: Reservation resources have been allocated, and the reservation is ready for use. `DELETING`: Reservation deletion is in progress. `UPDATING`: Reservation update is in progress.
`reservations[].shareSettings`	`object` Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.
`reservations[].shareSettings.shareType`	`enum` Type of sharing for this shared-reservation
`reservations[].shareSettings.projects[]`	`string` A regionCommitments.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.
`reservations[].shareSettings.projectMap[]`	`map (key: string, value: object)` A map of project id and project config. This is only valid when shareType's value is SPECIFIC_PROJECTS.
`reservations[].shareSettings.projectMap[].projectId`	`string` The project ID, should be same as the key of this project config in the parent map.
`reservations[].satisfiesPzs`	`boolean` [Output Only] Reserved for future use.
`reservations[].resourcePolicies`	`map (key: string, value: string)` Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.
`reservations[].resourceStatus`	`object` [Output Only] Status information for Reservation resource.
`reservations[].resourceStatus.specificSkuAllocation`	`object` Allocation Properties of this reservation.
`reservations[].resourceStatus.specificSkuAllocation.sourceInstanceTemplateId`	`string` ID of the instance template used to populate reservation properties.
`reservations[].resourceStatus.specificSkuAllocation.utilizations`	`map (key: string, value: string (int64 format))` Per service utilization breakdown. The Key is the Google Cloud managed service name.
`reservations[].resourceStatus.reservationMaintenance`	`object` Maintenance information for this reservation
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance`	`object` Maintenance information on this group of VMs.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.type`	`enum` Defines the type of maintenance.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.canReschedule`	`boolean` Indicates if the maintenance can be customer triggered.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.windowStartTime`	`string` The current start time of the maintenance window. This timestamp value is in RFC3339 text format.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.windowEndTime`	`string` The time by which the maintenance disruption will be completed. This timestamp value is in RFC3339 text format.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.latestWindowStartTime`	`string` The latest time for the planned maintenance window to start. This timestamp value is in RFC3339 text format.
`reservations[].resourceStatus.reservationMaintenance.upcomingGroupMaintenance.maintenanceStatus`	`enum`
`reservations[].resourceStatus.reservationMaintenance.enableOpportunisticMaintenance`	`boolean` This setting enables or disables opportunistic maintenance. If enabled, maintenance is performed on unused reservations whenever possible.
`reservations[].resourceStatus.reservationMaintenance.maintenanceOngoingCount`	`integer` Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have ongoing maintenance.
`reservations[].resourceStatus.reservationMaintenance.maintenancePendingCount`	`integer` Progress for ongoing maintenance for this group of VMs/hosts. Describes number of hosts in the block that have pending maintenance.
`reservations[].resourceStatus.reservationMaintenance.schedulingType`	`enum` The type of maintenance for the reservation.
`reservations[].resourceStatus.reservationBlockCount`	`integer` The number of reservation blocks associated with this reservation.
`reservations[].deleteAtTime`	`string` Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.
`reservations[].deleteAfterDuration`	`object` Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
`reservations[].deleteAfterDuration.seconds`	`string (int64 format)` Span of time at a resolution of a second. Must be from 0 to 315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
`reservations[].deleteAfterDuration.nanos`	`integer` Span of time that's a fraction of a second at nanosecond resolution. Durations less than one second are represented with a 0 `seconds` field and a positive `nanos` field. Must be from 0 to 999,999,999 inclusive.
`reservations[].reservationSharingPolicy`	`object` Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services.
`reservations[].reservationSharingPolicy.serviceShareType`	`enum` Sharing config for all Google Cloud services.
`reservations[].deploymentType`	`enum` Specifies the deployment strategy for this reservation.
`reservations[].instanceTerminationAction`	`enum` Instance termination action is invoked when the reservation is deleted. This only applies to reservations with a Deployment type.
`category`	`enum` The category of the commitment. Category `MACHINE` specifies commitments composed of machine resources such as `VCPU` or `MEMORY`, listed in `resources`. Category `LICENSE` specifies commitments composed of software licenses, listed in `licenseResources`. Note that only `MACHINE` commitments should have a `Type` specified.
`licenseResource`	`object` The license specification required as part of a license commitment.
`licenseResource.license`	`string` Any applicable license URI.
`licenseResource.amount`	`string (int64 format)` The number of licenses purchased.
`licenseResource.coresPerLicense`	`string` Specifies the core range of the instance for which this license applies.
`autoRenew`	`boolean` Specifies whether to enable automatic renewal for the commitment. The default value is `false` if not specified. The field can be updated until the day of the commitment expiration at 12:00am PST. If the field is set to true, the commitment will be automatically renewed for either one or three years according to the terms of the existing commitment.
`mergeSourceCommitments[]`	`string` regionCommitments.list of source commitments to be merged into a new commitment.
`splitSourceCommitment`	`string` Source commitment to be split into a new commitment.
`resourceStatus`	`object` [Output Only] Status information for Commitment resource.
`resourceStatus.customTermEligibilityEndTimestamp`	`string` [Output Only] Indicates the end time of customer's eligibility to send custom term requests in RFC3339 text format. Term extension requests that (not the end time in the request) after this time will be rejected.
`existingReservations[]`	`string` Specifies the already existing reservations to attach to the Commitment. This field is optional, and it can be a full or partial URL. For example, the following are valid URLs to an reservation: `https://www.googleapis.com/compute/v1/projects/project/zones/zone/reservations/reservation` `projects/project/zones/zone/reservations/reservation`
`customEndTimestamp`	`string` [Input Only] Optional, specifies the CUD end time requested by the customer in RFC3339 text format. Needed when the customer wants CUD's end date is later than the start date + term duration.

Response body

Represents an Operation resource.

Google Compute Engine has three Operation resources:

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 zoneOperations resource.

For more information, read Global, Regional, and Zonal Resources.

Note that completed Operation resources have a limited retention period.

If successful, the response body contains data with the following structure:

JSON representation

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "name": string, "zone": string, "clientOperationId": string, "operationType": string, "targetLink": string, "targetId": string, "status": enum, "statusMessage": string, "user": string, "progress": integer, "insertTime": string, "startTime": string, "endTime": string, "error": { "errors": [ { "code": string, "location": string, "message": string, "errorDetails": [ { "errorInfo": { "reason": string, "domain": string, "metadatas": { string: string, ... } }, "quotaInfo": { "metricName": string, "limitName": string, "dimensions": { string: string, ... }, "limit": number, "futureLimit": number, "rolloutStatus": enum }, "help": { "links": [ { "description": string, "url": string } ] }, "localizedMessage": { "locale": string, "message": string } } ] } ] }, "warnings": [ { "code": enum, "message": string, "data": [ { "key": string, "value": string } ] } ], "httpErrorStatusCode": integer, "httpErrorMessage": string, "selfLink": string, "region": string, "description": string, "operationGroupId": string, // Union field `metadata` can be only one of the following: "setCommonInstanceMetadataOperationMetadata": { "clientOperationId": string, "perLocationOperations": { string: { "state": enum, "error": { "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } }, ... } }, "instancesBulkInsertOperationMetadata": { "perLocationStatus": { string: { "status": enum, "targetVmCount": integer, "createdVmCount": integer, "failedToCreateVmCount": integer, "deletedVmCount": integer }, ... } } // End of list of possible types for union field `metadata`. }

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "name": string,
  "zone": string,
  "clientOperationId": string,
  "operationType": string,
  "targetLink": string,
  "targetId": string,
  "status": enum,
  "statusMessage": string,
  "user": string,
  "progress": integer,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    "errors": [
      {
        "code": string,
        "location": string,
        "message": string,
        "errorDetails": [
          {
            "errorInfo": {
              "reason": string,
              "domain": string,
              "metadatas": {
                string: string,
                ...
              }
            },
            "quotaInfo": {
              "metricName": string,
              "limitName": string,
              "dimensions": {
                string: string,
                ...
              },
              "limit": number,
              "futureLimit": number,
              "rolloutStatus": enum
            },
            "help": {
              "links": [
                {
                  "description": string,
                  "url": string
                }
              ]
            },
            "localizedMessage": {
              "locale": string,
              "message": string
            }
          }
        ]
      }
    ]
  },
  "warnings": [
    {
      "code": enum,
      "message": string,
      "data": [
        {
          "key": string,
          "value": string
        }
      ]
    }
  ],
  "httpErrorStatusCode": integer,
  "httpErrorMessage": string,
  "selfLink": string,
  "region": string,
  "description": string,
  "operationGroupId": string,

  // Union field metadata can be only one of the following:
  "setCommonInstanceMetadataOperationMetadata": {
    "clientOperationId": string,
    "perLocationOperations": {
      string: {
        "state": enum,
        "error": {
          "code": integer,
          "message": string,
          "details": [
            {
              "@type": string,
              field1: ...,
              ...
            }
          ]
        }
      },
      ...
    }
  },
  "instancesBulkInsertOperationMetadata": {
    "perLocationStatus": {
      string: {
        "status": enum,
        "targetVmCount": integer,
        "createdVmCount": integer,
        "failedToCreateVmCount": integer,
        "deletedVmCount": integer
      },
      ...
    }
  }
  // End of list of possible types for union field metadata.
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#operation` for Operation resources.
`id`	`string (uint64 format)` [Output Only] The unique identifier for the operation. This identifier is defined by the server.
`creationTimestamp`	`string` [Deprecated] This field is deprecated.
`name`	`string` [Output Only] Name of the operation.
`zone`	`string` [Output Only] The URL of the zone where the operation resides. Only applicable when performing per-zone operations.
`clientOperationId`	`string` [Output Only] The value of `requestId` if you provided it in the request. Not present otherwise.
`operationType`	`string` [Output Only] The type of operation, such as `insert`, `update`, or `delete`, and so on.
`targetLink`	`string` [Output Only] The URL of the resource that the operation modifies. For operations related to creating a snapshot, this points to the disk that the snapshot was created from.
`targetId`	`string (uint64 format)` [Output Only] The unique target ID, which identifies a specific incarnation of the target resource.
`status`	`enum` [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.
`user`	`string` [Output Only] User who requested the operation, for example: `user@example.com` or `alice_smith_identifier (global/workforcePools/example-com-us-employees)`.
`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.
`insertTime`	`string` [Output Only] The time that this operation was requested. This value is in RFC3339 text format.
`startTime`	`string` [Output Only] The time that this operation was started by the server. This value is in RFC3339 text format.
`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` [Output Only] The array of errors encountered while processing this operation.
`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.
`error.errors[].errorDetails[]`	`object` [Output Only] An optional list of messages that contain the error details. There is a set of defined message types to use for providing details.The syntax depends on the error code. For example, QuotaExceededInfo will have details when the error code is QUOTA_EXCEEDED.
`error.errors[].errorDetails[].errorInfo`	`object`
`error.errors[].errorDetails[].errorInfo.reason`	`string` The reason of the error. This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of `[A-Z][A-Z0-9_]+[A-Z0-9]`, which represents UPPER_SNAKE_CASE.
`error.errors[].errorDetails[].errorInfo.domain`	`string` The logical grouping to which the "reason" belongs. The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
`error.errors[].errorDetails[].errorInfo.metadatas`	`map (key: string, value: string)` Additional structured details about this error. Keys must match /[a-z][a-zA-Z0-9-_]+/ but should ideally be lowerCamelCase. Also they must be limited to 64 characters in length. When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, rather than {"instanceLimit": "100/request"}, should be returned as, {"instanceLimitPerRequest": "100"}, if the client exceeds the number of instances that can be created in a single (batch) request.
`error.errors[].errorDetails[].quotaInfo`	`object`
`error.errors[].errorDetails[].quotaInfo.metricName`	`string` The Compute Engine quota metric name.
`error.errors[].errorDetails[].quotaInfo.limitName`	`string` The name of the quota limit.
`error.errors[].errorDetails[].quotaInfo.dimensions`	`map (key: string, value: string)` The map holding related quota dimensions.
`error.errors[].errorDetails[].quotaInfo.limit`	`number` Current effective quota limit. The limit's unit depends on the quota type or metric.
`error.errors[].errorDetails[].quotaInfo.futureLimit`	`number` Future quota limit being rolled out. The limit's unit depends on the quota type or metric.
`error.errors[].errorDetails[].quotaInfo.rolloutStatus`	`enum` Rollout status of the future quota limit.
`error.errors[].errorDetails[].help`	`object`
`error.errors[].errorDetails[].help.links[]`	`object` URL(s) pointing to additional information on handling the current error.
`error.errors[].errorDetails[].help.links[].description`	`string` Describes what the link offers.
`error.errors[].errorDetails[].help.links[].url`	`string` The URL of the link.
`error.errors[].errorDetails[].localizedMessage`	`object`
`error.errors[].errorDetails[].localizedMessage.locale`	`string` The locale used following the specification defined at https://www.rfc-editor.org/rfc/bcp/bcp47.txt. Examples are: "en-US", "fr-CH", "es-MX"
`error.errors[].errorDetails[].localizedMessage.message`	`string` The localized error message in the above locale.
`warnings[]`	`object` [Output Only] If warning messages are generated during processing of the operation, this field will be populated.
`warnings[].code`	`enum` [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[].message`	`string` [Output Only] A human-readable description of the warning code.
`warnings[].data[]`	`object` [Output Only] Metadata about this warning in `key: value` format. For example: "data": [ { "key": "scope", "value": "zones/us-east1-d" }
`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.
`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.
`httpErrorMessage`	`string` [Output Only] If the operation fails, this field contains the HTTP error message that was returned, such as `NOT FOUND`.
`selfLink`	`string` [Output Only] Server-defined URL for the resource.
`region`	`string` [Output Only] The URL of the region where the operation resides. Only applicable when performing regional operations.
`description`	`string` [Output Only] A textual description of the operation, which is set when the operation is created.
`operationGroupId`	`string` [Output Only] An ID that represents a group of operations, such as when a group of operations results from a `bulkInsert` API request.
Union field `metadata`. [Output Only] Service-specific metadata attached to this operation. `metadata` can be only one of the following:
`setCommonInstanceMetadataOperationMetadata`	`object` [Output Only] If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state.
`setCommonInstanceMetadataOperationMetadata.clientOperationId`	`string` [Output Only] The client operation id.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[]`	`map (key: string, value: object)` [Output Only] Status information per location (location name is key). Example key: zones/us-central1-a
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state`	`enum` [Output Only] Status of the action, which can be one of the following: `PROPAGATING`, `PROPAGATED`, `ABANDONED`, `FAILED`, or `DONE`.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error`	`object` [Output Only] If state is `ABANDONED` or `FAILED`, this field is populated.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code`	`integer` The status code, which should be an enum value of `google.rpc.Code`.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message`	`string` A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the `google.rpc.Status.details` field, or localized by the client.
`setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[]`	`object` A list of messages that carry the error details. There is a common set of message types for APIs to use. An object containing fields of an arbitrary type. An additional field `"@type"` contains a URI identifying the type. Example: `{ "id": 1234, "@type": "types.example.com/standard/id" }`.
`instancesBulkInsertOperationMetadata`	`object`
`instancesBulkInsertOperationMetadata.perLocationStatus[]`	`map (key: string, value: object)` Status information per location (location name is key). Example key: zones/us-central1-a
`instancesBulkInsertOperationMetadata.perLocationStatus[].status`	`enum` [Output Only] Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back.
`instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount`	`integer` [Output Only] Count of VMs originally planned to be created.
`instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount`	`integer` [Output Only] Count of VMs successfully created so far.
`instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount`	`integer` [Output Only] Count of VMs that started creating but encountered an error.
`instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount`	`integer` [Output Only] Count of VMs that got deleted during rollback.

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:

compute.commitments.update

To find predefined roles that contain those permissions, see Compute Engine IAM Roles.