Method: futureReservations.update

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

Updates the specified future reservation.

HTTP request

PATCH https://compute.googleapis.com/compute/beta/projects/{project}/zones/{zone}/futureReservations/{futureReservation}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`project`	`string` Project ID for this request.
`zone`	`string` Name of the zone for this request. Name should conform to RFC1035.
`futureReservation`	`string` Name of the reservation to update. Name should conform to RFC1035.

project

string

Project ID for this request.

zone

string

Name of the zone for this request. Name should conform to RFC1035.

futureReservation

string

Name of the reservation to update. Name should conform to RFC1035.

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

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "selfLinkWithId": string, "zone": string, "description": string, "name": string, "timeWindow": { "startTime": string, "endTime": string, "duration": { "seconds": string, "nanos": integer } }, "shareSettings": { "shareType": enum, "projects": [ string ], "projectMap": { string: { "projectId": string }, ... } }, "namePrefix": string, "status": { "procurementStatus": enum, "lockTime": string, "autoCreatedReservations": [ string ], "fulfilledCount": string, "specificSkuProperties": { "sourceInstanceTemplateId": string }, "amendmentStatus": enum, "lastKnownGoodState": { "futureReservationSpecs": { "specificSkuProperties": { "instanceProperties": { "machineType": string, "guestAccelerators": [ { "acceleratorType": string, "acceleratorCount": integer } ], "minCpuPlatform": string, "localSsds": [ { "diskSizeGb": string, "interface": enum } ], "maintenanceFreezeDurationHours": integer, "locationHint": string, "maintenanceInterval": enum }, "totalCount": string, "sourceInstanceTemplate": string }, "timeWindow": { "startTime": string, // Union field `time` can be only one of the following: "endTime": string, "duration": { "seconds": string, "nanos": integer } // End of list of possible types for union field `time`. }, "shareSettings": { "shareType": enum, "projects": [ string ], "projectMap": { string: { "projectId": string }, ... } } }, "procurementStatus": enum, "namePrefix": string, "description": string, "lockTime": string, "existingMatchingUsageInfo": { "count": string, "timestamp": string } }, "existingMatchingUsageInfo": { "count": string, "timestamp": string } }, "planningStatus": enum, "autoDeleteAutoCreatedReservations": boolean, // Union field `type` can be only one of the following: "specificSkuProperties": { "instanceProperties": { "machineType": string, "guestAccelerators": [ { "acceleratorType": string, "acceleratorCount": integer } ], "minCpuPlatform": string, "localSsds": [ { "diskSizeGb": string, "interface": enum } ], "maintenanceFreezeDurationHours": integer, "locationHint": string, "maintenanceInterval": enum }, "totalCount": string, "sourceInstanceTemplate": string } // End of list of possible types for union field `type`. // Union field `auto_delete_auto_created_reservations_time` can be only one of // the following: "autoCreatedReservationsDeleteTime": string, "autoCreatedReservationsDuration": { "seconds": string, "nanos": integer } // End of list of possible types for union field // `auto_delete_auto_created_reservations_time`. }

{
  "kind": string,
  "id": string,
  "creationTimestamp": string,
  "selfLink": string,
  "selfLinkWithId": string,
  "zone": string,
  "description": string,
  "name": string,
  "timeWindow": {
    "startTime": string,
    "endTime": string,
    "duration": {
      "seconds": string,
      "nanos": integer
    }
  },
  "shareSettings": {
    "shareType": enum,
    "projects": [
      string
    ],
    "projectMap": {
      string: {
        "projectId": string
      },
      ...
    }
  },
  "namePrefix": string,
  "status": {
    "procurementStatus": enum,
    "lockTime": string,
    "autoCreatedReservations": [
      string
    ],
    "fulfilledCount": string,
    "specificSkuProperties": {
      "sourceInstanceTemplateId": string
    },
    "amendmentStatus": enum,
    "lastKnownGoodState": {
      "futureReservationSpecs": {
        "specificSkuProperties": {
          "instanceProperties": {
            "machineType": string,
            "guestAccelerators": [
              {
                "acceleratorType": string,
                "acceleratorCount": integer
              }
            ],
            "minCpuPlatform": string,
            "localSsds": [
              {
                "diskSizeGb": string,
                "interface": enum
              }
            ],
            "maintenanceFreezeDurationHours": integer,
            "locationHint": string,
            "maintenanceInterval": enum
          },
          "totalCount": string,
          "sourceInstanceTemplate": string
        },
        "timeWindow": {
          "startTime": string,

          // Union field time can be only one of the following:
          "endTime": string,
          "duration": {
            "seconds": string,
            "nanos": integer
          }
          // End of list of possible types for union field time.
        },
        "shareSettings": {
          "shareType": enum,
          "projects": [
            string
          ],
          "projectMap": {
            string: {
              "projectId": string
            },
            ...
          }
        }
      },
      "procurementStatus": enum,
      "namePrefix": string,
      "description": string,
      "lockTime": string,
      "existingMatchingUsageInfo": {
        "count": string,
        "timestamp": string
      }
    },
    "existingMatchingUsageInfo": {
      "count": string,
      "timestamp": string
    }
  },
  "planningStatus": enum,
  "autoDeleteAutoCreatedReservations": boolean,

  // Union field type can be only one of the following:
  "specificSkuProperties": {
    "instanceProperties": {
      "machineType": string,
      "guestAccelerators": [
        {
          "acceleratorType": string,
          "acceleratorCount": integer
        }
      ],
      "minCpuPlatform": string,
      "localSsds": [
        {
          "diskSizeGb": string,
          "interface": enum
        }
      ],
      "maintenanceFreezeDurationHours": integer,
      "locationHint": string,
      "maintenanceInterval": enum
    },
    "totalCount": string,
    "sourceInstanceTemplate": string
  }
  // End of list of possible types for union field type.

  // Union field auto_delete_auto_created_reservations_time can be only one of
  // the following:
  "autoCreatedReservationsDeleteTime": string,
  "autoCreatedReservationsDuration": {
    "seconds": string,
    "nanos": integer
  }
  // End of list of possible types for union field
  // auto_delete_auto_created_reservations_time.
}

Fields
`kind`	`string` [Output Only] Type of the resource. Always `compute#futureReservation` for future reservations.
`id`	`string (uint64 format)` [Output Only] A unique identifier for this future reservation. The server defines this identifier.
`creationTimestamp`	`string` [Output Only] The creation timestamp for this future reservation in RFC3339 text format.
`selfLink`	`string` [Output Only] Server-defined fully-qualified URL for this resource.
`selfLinkWithId`	`string` [Output Only] Server-defined URL for this resource with the resource id.
`zone`	`string` [Output Only] URL of the Zone where this future reservation resides.
`description`	`string` An optional description of this resource. Provide this property when you create the future reservation.
`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.
`timeWindow`	`object` Time window for this Future Reservation.
`timeWindow.startTime`	`string` Start time of the Future Reservation. The startTime is an RFC3339 string.
`timeWindow.endTime`	`string`
`timeWindow.duration`	`object`
`timeWindow.duration.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
`timeWindow.duration.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.
`shareSettings`	`object` futureReservations.list of Projects/Folders to share with.
`shareSettings.shareType`	`enum` Type of sharing for this shared-reservation
`shareSettings.projects[]`	`string` A futureReservations.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.
`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.
`shareSettings.projectMap[].projectId`	`string` The project ID, should be same as the key of this project config in the parent map.
`namePrefix`	`string` Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####.
`status`	`object` [Output only] Status of the Future Reservation
`status.procurementStatus`	`enum` Current state of this Future Reservation
`status.lockTime`	`string` Time when Future Reservation would become LOCKED, after which no modifications to Future Reservation will be allowed. Applicable only after the Future Reservation is in the APPROVED state. The lockTime is an RFC3339 string. The procurementStatus will transition to PROCURING state at this time.
`status.autoCreatedReservations[]`	`string` Fully qualified urls of the automatically created reservations at startTime.
`status.fulfilledCount`	`string (int64 format)` This count indicates the fulfilled capacity so far. This is set during "PROVISIONING" state. This count also includes capacity delivered as part of existing matching reservations.
`status.specificSkuProperties`	`object`
`status.specificSkuProperties.sourceInstanceTemplateId`	`string` ID of the instance template used to populate the Future Reservation properties.
`status.amendmentStatus`	`enum` [Output Only] The current status of the requested amendment.
`status.lastKnownGoodState`	`object` [Output Only] This field represents the future reservation before an amendment was requested. If the amendment is declined, the Future Reservation will be reverted to the last known good state. The last known good state is not set when updating a future reservation whose Procurement Status is DRAFTING.
`status.lastKnownGoodState.futureReservationSpecs`	`object`
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties`	`object` [Output Only] The previous instance related properties of the Future Reservation.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties`	`object` Properties of the SKU instances being reserved.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.guestAccelerators[]`	`object` Specifies accelerator type and count.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.guestAccelerators[].acceleratorCount`	`integer` The number of the guest accelerator cards exposed to this instance.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.minCpuPlatform`	`string` Minimum cpu platform the reservation.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.localSsds[]`	`object` Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.localSsds[].diskSizeGb`	`string (int64 format)` Specifies the size of the disk in base-2 GB.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.maintenanceFreezeDurationHours`	`integer` Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.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.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.maintenanceInterval`	`enum` Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.totalCount`	`string (int64 format)` Total number of instances for which capacity assurance is requested at a future time period.
`status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.sourceInstanceTemplate`	`string` The instance template that will be used to populate the ReservedInstanceProperties of the future reservation
`status.lastKnownGoodState.futureReservationSpecs.timeWindow`	`object` [Output Only] The previous time window of the Future Reservation.
`status.lastKnownGoodState.futureReservationSpecs.timeWindow.startTime`	`string` Start time of the Future Reservation. The startTime is an RFC3339 string.
`status.lastKnownGoodState.futureReservationSpecs.timeWindow.endTime`	`string`
`status.lastKnownGoodState.futureReservationSpecs.timeWindow.duration`	`object`
`status.lastKnownGoodState.futureReservationSpecs.timeWindow.duration.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
`status.lastKnownGoodState.futureReservationSpecs.timeWindow.duration.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.
`status.lastKnownGoodState.futureReservationSpecs.shareSettings`	`object` [Output Only] The previous share settings of the Future Reservation.
`status.lastKnownGoodState.futureReservationSpecs.shareSettings.shareType`	`enum` Type of sharing for this shared-reservation
`status.lastKnownGoodState.futureReservationSpecs.shareSettings.projects[]`	`string` A futureReservations.list of Project names to specify consumer projects for this shared-reservation. This is only valid when shareType's value is SPECIFIC_PROJECTS.
`status.lastKnownGoodState.futureReservationSpecs.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.
`status.lastKnownGoodState.futureReservationSpecs.shareSettings.projectMap[].projectId`	`string` The project ID, should be same as the key of this project config in the parent map.
`status.lastKnownGoodState.procurementStatus`	`enum` [Output Only] The status of the last known good state for the Future Reservation.
`status.lastKnownGoodState.namePrefix`	`string` [Output Only] The name prefix of the Future Reservation before an amendment was requested.
`status.lastKnownGoodState.description`	`string` [Output Only] The description of the FutureReservation before an amendment was requested.
`status.lastKnownGoodState.lockTime`	`string` [Output Only] The lock time of the FutureReservation before an amendment was requested.
`status.lastKnownGoodState.existingMatchingUsageInfo`	`object` [Output Only] Represents the matching usage for the future reservation before an amendment was requested.
`status.lastKnownGoodState.existingMatchingUsageInfo.count`	`string (int64 format)` Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)
`status.lastKnownGoodState.existingMatchingUsageInfo.timestamp`	`string` Timestamp when the matching usage was calculated
`status.existingMatchingUsageInfo`	`object` [Output Only] Represents the existing matching usage for the future reservation.
`status.existingMatchingUsageInfo.count`	`string (int64 format)` Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)
`status.existingMatchingUsageInfo.timestamp`	`string` Timestamp when the matching usage was calculated
`planningStatus`	`enum` Planning state before being submitted for evaluation
`autoDeleteAutoCreatedReservations`	`boolean` Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [autoCreatedReservationsDeleteTime, autoCreatedReservationsDuration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.
Union field `type`. `type` can be only one of the following:
`specificSkuProperties`	`object` Future Reservation configuration to indicate instance properties and total count.
`specificSkuProperties.instanceProperties`	`object` Properties of the SKU instances being reserved.
`specificSkuProperties.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.
`specificSkuProperties.instanceProperties.guestAccelerators[]`	`object` Specifies accelerator type and count.
`specificSkuProperties.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.
`specificSkuProperties.instanceProperties.guestAccelerators[].acceleratorCount`	`integer` The number of the guest accelerator cards exposed to this instance.
`specificSkuProperties.instanceProperties.minCpuPlatform`	`string` Minimum cpu platform the reservation.
`specificSkuProperties.instanceProperties.localSsds[]`	`object` Specifies amount of local ssd to reserve with each instance. The type of disk is local-ssd.
`specificSkuProperties.instanceProperties.localSsds[].diskSizeGb`	`string (int64 format)` Specifies the size of the disk in base-2 GB.
`specificSkuProperties.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.
`specificSkuProperties.instanceProperties.maintenanceFreezeDurationHours`	`integer` Specifies the number of hours after reservation creation where instances using the reservation won't be scheduled for maintenance.
`specificSkuProperties.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.
`specificSkuProperties.instanceProperties.maintenanceInterval`	`enum` Specifies the frequency of planned maintenance events. The accepted values are: `PERIODIC`.
`specificSkuProperties.totalCount`	`string (int64 format)` Total number of instances for which capacity assurance is requested at a future time period.
`specificSkuProperties.sourceInstanceTemplate`	`string` The instance template that will be used to populate the ReservedInstanceProperties of the future reservation
Union field `auto_delete_auto_created_reservations_time`. `auto_delete_auto_created_reservations_time` can be only one of the following:
`autoCreatedReservationsDeleteTime`	`string` Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid href="https://www.ietf.org/rfc/rfc3339.txt">RFC3339 value.
`autoCreatedReservationsDuration`	`object` Specifies the duration of auto-created reservations. It represents relative time to future reservation startTime when auto-created reservations will be automatically deleted by Compute Engine. Duration time unit is represented as a count of seconds and fractions of seconds at nanosecond resolution.
`autoCreatedReservationsDuration.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
`autoCreatedReservationsDuration.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.

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.futureReservations.update

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