Updates the specified future reservation.
PATCH https://compute.googleapis.com/compute/v1/projects/{project}/zones/{zone}/futureReservations/{futureReservation}
The URL uses gRPC Transcoding syntax. To know more about valid error responses that can be thrown by this HTTP request, please refer to the service error catalog
| Parameters | |
|---|---|
project |
Project ID for this request. |
zone |
Name of the zone for this request. Name should conform to RFC1035. |
futureReservation |
Name of the reservation to update. Name should conform to RFC1035. |
| Parameters | |
|---|---|
requestId |
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 ( |
The request body contains data with the following structure:
| JSON representation |
|---|
{ "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "selfLinkWithId": string, "zone": string, "description": string, "name": string, "timeWindow": { "endTime": string, "duration": { "seconds": string, "nanos": integer }, "startTime": string }, "shareSettings": { "shareType": enum, "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 } ], "locationHint": string }, "totalCount": string, "sourceInstanceTemplate": string }, "timeWindow": { "startTime": string, // Union field |
kindstring
Output only. Type of the resource. Always compute#futureReservation for future reservations.
idstring (uint64 format)
Output only. A unique identifier for this future reservation. The server defines this identifier.
creationTimestampstring
Output only. The creation timestamp for this future reservation in RFC3339 text format.
selfLinkstring
Output only. Server-defined fully-qualified URL for this resource.
selfLinkWithIdstring
Output only. Server-defined URL for this resource with the resource id.
zonestring
Output only. URL of the Zone where this future reservation resides.
descriptionstring
An optional description of this resource. Provide this property when you create the future reservation.
namestring
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.
timeWindowobject
Time window for this Future Reservation.
timeWindow.endTimestring
timeWindow.durationobject
timeWindow.duration.secondsstring (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.nanosinteger
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.
timeWindow.startTimestring
Start time of the Future Reservation. The startTime is an RFC3339 string.
shareSettingsobject
futureReservations.list of Projects/Folders to share with.
shareSettings.shareTypeenum
Type of sharing for this shared-reservation
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[].projectIdstring
The project ID, should be same as the key of this project config in the parent map.
namePrefixstring
statusobject
Output only. Status of the Future Reservation
status.procurementStatusenum
Output only. Current state of this Future Reservation
status.lockTimestring
Output only. 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
Output only. Fully qualified urls of the automatically created reservations at startTime.
status.fulfilledCountstring (int64 format)
Output only. 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.specificSkuPropertiesobject
status.specificSkuProperties.sourceInstanceTemplateIdstring
ID of the instance template used to populate the Future Reservation properties.
status.amendmentStatusenum
Output only. The current status of the requested amendment.
status.lastKnownGoodStateobject
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.futureReservationSpecsobject
status.lastKnownGoodState.futureReservationSpecs.specificSkuPropertiesobject
Output only. The previous instance related properties of the Future Reservation.
status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instancePropertiesobject
Properties of the SKU instances being reserved.
status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.machineTypestring
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[].acceleratorTypestring
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[].acceleratorCountinteger
The number of the guest accelerator cards exposed to this instance.
status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.minCpuPlatformstring
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[].diskSizeGbstring (int64 format)
Specifies the size of the disk in base-2 GB.
status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.instanceProperties.localSsds[].interfaceenum
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.locationHintstring
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.totalCountstring (int64 format)
Total number of instances for which capacity assurance is requested at a future time period.
status.lastKnownGoodState.futureReservationSpecs.specificSkuProperties.sourceInstanceTemplatestring
The instance template that will be used to populate the ReservedInstanceProperties of the future reservation
status.lastKnownGoodState.futureReservationSpecs.timeWindowobject
Output only. The previous time window of the Future Reservation.
status.lastKnownGoodState.futureReservationSpecs.timeWindow.endTimestring
status.lastKnownGoodState.futureReservationSpecs.timeWindow.durationobject
status.lastKnownGoodState.futureReservationSpecs.timeWindow.duration.secondsstring (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.nanosinteger
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.timeWindow.startTimestring
Start time of the Future Reservation. The startTime is an RFC3339 string.
status.lastKnownGoodState.futureReservationSpecs.shareSettingsobject
Output only. The previous share settings of the Future Reservation.
status.lastKnownGoodState.futureReservationSpecs.shareSettings.shareTypeenum
Type of sharing for this shared-reservation
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[].projectIdstring
The project ID, should be same as the key of this project config in the parent map.
status.lastKnownGoodState.procurementStatusenum
Output only. The status of the last known good state for the Future Reservation.
status.lastKnownGoodState.namePrefixstring
Output only. The name prefix of the Future Reservation before an amendment was requested.
status.lastKnownGoodState.descriptionstring
Output only. The description of the FutureReservation before an amendment was requested.
status.lastKnownGoodState.lockTimestring
Output only. The lock time of the FutureReservation before an amendment was requested.
status.lastKnownGoodState.existingMatchingUsageInfoobject
Output only. Represents the matching usage for the future reservation before an amendment was requested.
status.lastKnownGoodState.existingMatchingUsageInfo.countstring (int64 format)
Output only. Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)
status.lastKnownGoodState.existingMatchingUsageInfo.timestampstring
Output only. Timestamp when the matching usage was calculated
status.existingMatchingUsageInfoobject
Output only. Represents the existing matching usage for the future reservation.
status.existingMatchingUsageInfo.countstring (int64 format)
Output only. Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)
status.existingMatchingUsageInfo.timestampstring
Output only. Timestamp when the matching usage was calculated
planningStatusenum
Planning state before being submitted for evaluation
autoDeleteAutoCreatedReservationsboolean
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.
specificReservationRequiredboolean
Indicates whether the auto-created 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 the delivered reservation.
reservationNamestring
Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservationName or a namePrefix.
deploymentTypeenum
Type of the deployment requested as part of future reservation.
commitmentInfoobject
If not present, then FR will not deliver a new commitment or update an existing commitment.
commitmentInfo.commitmentPlanenum
Indicates if a Commitment needs to be created as part of FR delivery. If this field is not present, then no commitment needs to be created.
commitmentInfo.commitmentNamestring
name of the commitment where capacity is being delivered to.
commitmentInfo.previousCommitmentTermsenum
Only applicable if FR is delivering to the same reservation. If set, all parent commitments will be extended to match the end date of the plan for this commitment.
schedulingTypeenum
Maintenance information for this reservation
reservationModeenum
The reservation mode which determines reservation-termination behavior and expected pricing.
enableEmergentMaintenanceboolean
Indicates if this group of VMs have emergent maintenance enabled.
paramsobject
Input only. Additional params passed with the request, but not persisted as part of resource payload.
params.resourceManagerTagsmap (key: string, value: string)
Input only. Resource manager tags to be bound to the future reservation. Tag keys and values have the same definition as resource manager tags. Keys and values can be either in numeric format, such as tagKeys/{tag_key_id} and tagValues/{tag_value_id} or in namespaced format such as {org_id|projectId}/{tag_key_short_name} and {tag_value_short_name}. The field is ignored (both PUT & PATCH) when empty.
confidentialComputeTypeenum
resourceMetadataobject
Output only. Contains standard resource metadata for an FutureReservation resource. It is populated for each instance of the FutureReservation resource, and includes the apiVersion the instance was retrieved through, and its canonical resourceType name.
resourceMetadata.resourceTypestring
The canonical resource type name in the format of a resource type as defined by AIP-123. For example, "compute.googleapis.com/Instance".
resourceMetadata.apiVersionstring
The version of the API interface that this resource was retrieved through. For example, "2025-01-01" or "2025-01-01-preview".
Union field type.
type can be only one of the following:
specificSkuPropertiesobject
Future Reservation configuration to indicate instance properties and total count.
specificSkuProperties.instancePropertiesobject
Properties of the SKU instances being reserved.
specificSkuProperties.instanceProperties.machineTypestring
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[].acceleratorTypestring
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[].acceleratorCountinteger
The number of the guest accelerator cards exposed to this instance.
specificSkuProperties.instanceProperties.minCpuPlatformstring
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[].diskSizeGbstring (int64 format)
Specifies the size of the disk in base-2 GB.
specificSkuProperties.instanceProperties.localSsds[].interfaceenum
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.locationHintstring
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.totalCountstring (int64 format)
Total number of instances for which capacity assurance is requested at a future time period.
specificSkuProperties.sourceInstanceTemplatestring
The instance template that will be used to populate the ReservedInstanceProperties of the future reservation
aggregateReservationobject
Aggregate reservation details for the future reservation.
aggregateReservation.vmFamilyenum
The VM family that all instances scheduled against this reservation must belong to.
aggregateReservation.reservedResources[]object
futureReservations.list of reserved resources (CPUs, memory, accelerators).
aggregateReservation.reservedResources[].acceleratorobject
Properties of accelerator resources in this reservation.
aggregateReservation.reservedResources[].accelerator.acceleratorCountinteger
Number of accelerators of specified type.
aggregateReservation.reservedResources[].accelerator.acceleratorTypestring
Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
aggregateReservation.inUseResources[]object
Output only. futureReservations.list of resources currently in use.
aggregateReservation.inUseResources[].acceleratorobject
Properties of accelerator resources in this reservation.
aggregateReservation.inUseResources[].accelerator.acceleratorCountinteger
Number of accelerators of specified type.
aggregateReservation.inUseResources[].accelerator.acceleratorTypestring
Full or partial URL to accelerator type. e.g. "projects/{PROJECT}/zones/{ZONE}/acceleratorTypes/ct4l"
aggregateReservation.workloadTypeenum
The workload type of the instances that will target this reservation.
Union field auto_delete_auto_created_reservations_time.
auto_delete_auto_created_reservations_time can be only one of the following:
autoCreatedReservationsDeleteTimestring
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.
autoCreatedReservationsDurationobject
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.secondsstring (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.nanosinteger
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.
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.
globalOperations resource.regionOperations resource.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 |
|---|
{ "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 |
| Fields | |
|---|---|
kind |
Output only. Type of the resource. Always |
id |
Output only. The unique identifier for the operation. This identifier is defined by the server. |
creationTimestamp |
[Deprecated] This field is deprecated. |
name |
Output only. Name of the operation. |
zone |
Output only. The URL of the zone where the operation resides. Only applicable when performing per-zone operations. |
clientOperationId |
Output only. The value of |
operationType |
Output only. The type of operation, such as |
targetLink |
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 |
Output only. The unique target ID, which identifies a specific incarnation of the target resource. |
status |
Output only. The status of the operation, which can be one of the following: |
statusMessage |
Output only. An optional textual description of the current status of the operation. |
user |
Output only. User who requested the operation, for example: |
progress |
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 |
Output only. The time that this operation was requested. This value is in RFC3339 text format. |
startTime |
Output only. The time that this operation was started by the server. This value is in RFC3339 text format. |
endTime |
Output only. The time that this operation was completed. This value is in RFC3339 text format. |
error |
Output only. If errors are generated during processing of the operation, this field will be populated. |
error.errors[] |
Output only. The array of errors encountered while processing this operation. |
error.errors[].code |
Output only. The error type identifier for this error. |
error.errors[].location |
Output only. Indicates the field in the request that caused the error. This property is optional. |
error.errors[].message |
Output only. An optional, human-readable error message. |
error.errors[].errorDetails[] |
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 |
|
error.errors[].errorDetails[].errorInfo.reason |
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 |
error.errors[].errorDetails[].errorInfo.domain |
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 |
Additional structured details about this error. Keys must match a regular expression of |
error.errors[].errorDetails[].quotaInfo |
|
error.errors[].errorDetails[].quotaInfo.metricName |
The Compute Engine quota metric name. |
error.errors[].errorDetails[].quotaInfo.limitName |
The name of the quota limit. |
error.errors[].errorDetails[].quotaInfo.dimensions |
The map holding related quota dimensions. |
error.errors[].errorDetails[].quotaInfo.limit |
Current effective quota limit. The limit's unit depends on the quota type or metric. |
error.errors[].errorDetails[].quotaInfo.futureLimit |
Future quota limit being rolled out. The limit's unit depends on the quota type or metric. |
error.errors[].errorDetails[].quotaInfo.rolloutStatus |
Rollout status of the future quota limit. |
error.errors[].errorDetails[].help |
|
error.errors[].errorDetails[].help.links[] |
URL(s) pointing to additional information on handling the current error. |
error.errors[].errorDetails[].help.links[].description |
Describes what the link offers. |
error.errors[].errorDetails[].help.links[].url |
The URL of the link. |
error.errors[].errorDetails[].localizedMessage |
|
error.errors[].errorDetails[].localizedMessage.locale |
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 |
The localized error message in the above locale. |
warnings[] |
Output only. If warning messages are generated during processing of the operation, this field will be populated. |
warnings[].code |
Output only. A warning code, if applicable. For example, Compute Engine returns |
warnings[].message |
Output only. A human-readable description of the warning code. |
warnings[].data[] |
Output only. Metadata about this warning in "data": [ { "key": "scope", "value": "zones/us-east1-d" } |
warnings[].data[].key |
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 |
warnings[].data[].value |
Output only. A warning data value corresponding to the key. |
httpErrorStatusCode |
Output only. If the operation fails, this field contains the HTTP error status code that was returned. For example, a |
httpErrorMessage |
Output only. If the operation fails, this field contains the HTTP error message that was returned, such as |
selfLink |
Output only. Server-defined URL for the resource. |
region |
Output only. The URL of the region where the operation resides. Only applicable when performing regional operations. |
description |
Output only. A textual description of the operation, which is set when the operation is created. |
operationGroupId |
Output only. An ID that represents a group of operations, such as when a group of operations results from a |
Union field metadata. Output only. Service-specific metadata attached to this operation. metadata can be only one of the following: |
|
setCommonInstanceMetadataOperationMetadata |
Output only. If the operation is for projects.setCommonInstanceMetadata, this field will contain information on all underlying zonal actions and their state. |
setCommonInstanceMetadataOperationMetadata.clientOperationId |
Output only. The client operation id. |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[] |
Output only. Status information per location (location name is key). Example key: zones/us-central1-a |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].state |
Output only. Status of the action, which can be one of the following: |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error |
Output only. If state is |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.code |
The status code, which should be an enum value of |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.message |
A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the |
setCommonInstanceMetadataOperationMetadata.perLocationOperations[].error.details[] |
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 |
instancesBulkInsertOperationMetadata |
|
instancesBulkInsertOperationMetadata.perLocationStatus[] |
Status information per location (location name is key). Example key: zones/us-central1-a |
instancesBulkInsertOperationMetadata.perLocationStatus[].status |
Output only. Creation status of BulkInsert operation - information if the flow is rolling forward or rolling back. |
instancesBulkInsertOperationMetadata.perLocationStatus[].targetVmCount |
Output only. Count of VMs originally planned to be created. |
instancesBulkInsertOperationMetadata.perLocationStatus[].createdVmCount |
Output only. Count of VMs successfully created so far. |
instancesBulkInsertOperationMetadata.perLocationStatus[].failedToCreateVmCount |
Output only. Count of VMs that started creating but encountered an error. |
instancesBulkInsertOperationMetadata.perLocationStatus[].deletedVmCount |
Output only. Count of VMs that got deleted during rollback. |
getVersionOperationMetadata |
|
getVersionOperationMetadata.inlineSbomInfo |
|
getVersionOperationMetadata.inlineSbomInfo.currentComponentVersions |
A mapping of components to their currently-applied versions or other appropriate identifiers. |
getVersionOperationMetadata.inlineSbomInfo.targetComponentVersions |
A mapping of components to their target versions or other appropriate identifiers. |
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/compute
https://www.googleapis.com/auth/cloud-platformFor more information, see the Authentication Overview.
In addition to any permissions specified on the fields above, authorization requires one or more of the following IAM permissions:
compute.futureReservations.updateTo find predefined roles that contain those permissions, see Compute Engine IAM Roles.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-05-13 UTC.