Sign in

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-131,0021,0174.3 MB
futureReservations

Updates the specified future reservation.

patch/projects/{project}/zones/{zone}/futureReservations/{futureReservation}

Path parameters

projectstring required

Project ID for this request.

zonestring required

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

futureReservationstring required

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

Query parameters

requestIdstring

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

updateMaskstring

update_mask indicates fields to be updated as part of this request.

Request body

selfLinkstring

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

schedulingType'GROUPED' | 'GROUP_MAINTENANCE_TYPE_UNSPECIFIED' | 'INDEPENDENT'

Maintenance information for this 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 reservation_name or a name_prefix.

selfLinkWithIdstring

Output only. [Output Only] Server-defined URL for this resource with the resource id.

kindstring

Output only. [Output Only] Type of the resource. Alwayscompute#futureReservation for future reservations.

descriptionstring

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

deploymentType'DENSE' | 'DEPLOYMENT_TYPE_UNSPECIFIED'

Type of the deployment requested as part of future reservation.

confidentialComputeType'CONFIDENTIAL_COMPUTE_TYPE_TDX' | 'CONFIDENTIAL_COMPUTE_TYPE_UNSPECIFIED'
namePrefixstring

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

zonestring

Output only. [Output Only] URL of the Zone where this future reservation resides.

planningStatus'DRAFT' | 'PLANNING_STATUS_UNSPECIFIED' | 'SUBMITTED'

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 [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto-created reservation indefinitely, this value should be set to false.

idstring uint64

Output only. [Output Only] A unique identifier for this future reservation. The server defines this identifier.

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

enableEmergentMaintenanceboolean

Indicates if this group of VMs have emergent maintenance enabled.

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.

reservationMode'CALENDAR' | 'DEFAULT' | 'RESERVATION_MODE_UNSPECIFIED'

The reservation mode which determines reservation-termination behavior and expected pricing.

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.

creationTimestampstring

Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 text format.

Response

Successful response