Skip to main content

future_reservations

Creates, updates, deletes, gets or lists a future_reservations resource.

Overview

Namefuture_reservations
TypeResource
Idgoogle.compute.future_reservations

Fields

NameDatatypeDescription
idstring[Output Only] A unique identifier for this future reservation. The server defines this identifier.
namestringThe 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.
descriptionstringAn optional description of this resource. Provide this property when you create the future reservation.
autoCreatedReservationsDeleteTimestringFuture 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.
autoCreatedReservationsDurationobjectA Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years.
autoDeleteAutoCreatedReservationsbooleanSetting 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.
creationTimestampstring[Output Only] The creation timestamp for this future reservation in RFC3339 text format.
kindstring[Output Only] Type of the resource. Always compute#futureReservation for future reservations.
namePrefixstringName 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-####.
planningStatusstringPlanning state before being submitted for evaluation
selfLinkstring[Output Only] Server-defined fully-qualified URL for this resource.
selfLinkWithIdstring[Output Only] Server-defined URL for this resource with the resource id.
shareSettingsobjectThe share setting for reservations and sole tenancy node groups.
specificSkuPropertiesobject
statusobject[Output only] Represents status related to the future reservation.
timeWindowobject
zonestring[Output Only] URL of the Zone where this future reservation resides.

Methods

NameAccessible byRequired ParamsDescription
aggregated_listSELECTprojectRetrieves an aggregated list of future reservations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.
getSELECTfutureReservation, project, zoneRetrieves information about the specified future reservation.
listSELECTproject, zoneA list of all the future reservations that have been configured for the specified project in specified zone.
insertINSERTproject, zoneCreates a new Future Reservation.
deleteDELETEfutureReservation, project, zoneDeletes the specified future reservation.
updateUPDATEfutureReservation, project, zoneUpdates the specified future reservation.
cancelEXECfutureReservation, project, zoneCancel the specified future reservation.

SELECT examples

Retrieves an aggregated list of future reservations. To prevent failure, Google recommends that you set the returnPartialSuccess parameter to true.

SELECT
id,
name,
description,
autoCreatedReservationsDeleteTime,
autoCreatedReservationsDuration,
autoDeleteAutoCreatedReservations,
creationTimestamp,
kind,
namePrefix,
planningStatus,
selfLink,
selfLinkWithId,
shareSettings,
specificSkuProperties,
status,
timeWindow,
zone
FROM google.compute.future_reservations
WHERE project = '{{ project }}';

INSERT example

Use the following StackQL query and manifest file to create a new future_reservations resource.

/*+ create */
INSERT INTO google.compute.future_reservations (
project,
zone,
zone,
description,
name,
specificSkuProperties,
timeWindow,
shareSettings,
namePrefix,
status,
planningStatus,
autoCreatedReservationsDeleteTime,
autoCreatedReservationsDuration,
autoDeleteAutoCreatedReservations
)
SELECT
'{{ project }}',
'{{ zone }}',
'{{ zone }}',
'{{ description }}',
'{{ name }}',
'{{ specificSkuProperties }}',
'{{ timeWindow }}',
'{{ shareSettings }}',
'{{ namePrefix }}',
'{{ status }}',
'{{ planningStatus }}',
'{{ autoCreatedReservationsDeleteTime }}',
'{{ autoCreatedReservationsDuration }}',
{{ autoDeleteAutoCreatedReservations }}
;

UPDATE example

Updates a future_reservations resource.

/*+ update */
UPDATE google.compute.future_reservations
SET
zone = '{{ zone }}',
description = '{{ description }}',
name = '{{ name }}',
specificSkuProperties = '{{ specificSkuProperties }}',
timeWindow = '{{ timeWindow }}',
shareSettings = '{{ shareSettings }}',
namePrefix = '{{ namePrefix }}',
status = '{{ status }}',
planningStatus = '{{ planningStatus }}',
autoCreatedReservationsDeleteTime = '{{ autoCreatedReservationsDeleteTime }}',
autoCreatedReservationsDuration = '{{ autoCreatedReservationsDuration }}',
autoDeleteAutoCreatedReservations = true|false
WHERE
futureReservation = '{{ futureReservation }}'
AND project = '{{ project }}'
AND zone = '{{ zone }}';

DELETE example

Deletes the specified future_reservations resource.

/*+ delete */
DELETE FROM google.compute.future_reservations
WHERE futureReservation = '{{ futureReservation }}'
AND project = '{{ project }}'
AND zone = '{{ zone }}';