FutureReservation

JSON representation
SpecificSKUProperties
- JSON representation
TimeWindow
- JSON representation
Status
- JSON representation
ProcurementStatus
SpecificSKUProperties
- JSON representation
AmendmentStatus
LastKnownGoodState
- JSON representation
FutureReservationSpecs
- JSON representation
ExistingMatchingUsageInfo
- JSON representation
PlanningStatus
CommitmentInfo
- JSON representation
PreviousCommitmentsTerm

JSON representation

JSON representation
{ "kind": string, "id": string, "creationTimestamp": string, "selfLink": string, "selfLinkWithId": string, "zone": string, "description": string, "name": string, "timeWindow": { object (`TimeWindow`) }, "shareSettings": { object (`ShareSettings`) }, "namePrefix": string, "status": { object (`Status`) }, "planningStatus": enum (`PlanningStatus`), "autoDeleteAutoCreatedReservations": boolean, "specificReservationRequired": boolean, "reservationName": string, "deploymentType": enum (`DeploymentType`), "commitmentInfo": { object (`CommitmentInfo`) }, "schedulingType": enum (`SchedulingType`), "enableEmergentMaintenance": boolean, // Union field `type` can be only one of the following: "specificSkuProperties": { object (`SpecificSKUProperties`) }, "aggregateReservation": { object (`AggregateReservation`) } // 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": { object (`Duration`) } // 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": {
    object (TimeWindow)
  },
  "shareSettings": {
    object (ShareSettings)
  },
  "namePrefix": string,
  "status": {
    object (Status)
  },
  "planningStatus": enum (PlanningStatus),
  "autoDeleteAutoCreatedReservations": boolean,
  "specificReservationRequired": boolean,
  "reservationName": string,
  "deploymentType": enum (DeploymentType),
  "commitmentInfo": {
    object (CommitmentInfo)
  },
  "schedulingType": enum (SchedulingType),
  "enableEmergentMaintenance": boolean,

  // Union field type can be only one of the following:
  "specificSkuProperties": {
    object (SpecificSKUProperties)
  },
  "aggregateReservation": {
    object (AggregateReservation)
  }
  // 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": {
    object (Duration)
  }
  // End of list of possible types for union field
  // auto_delete_auto_created_reservations_time.
}

Fields

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 (TimeWindow)` Time window for this Future Reservation.
`shareSettings`	`object (ShareSettings)` List of Projects/Folders to share with.
`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 (Status)` [Output only] Status of the Future Reservation
`planningStatus`	`enum (PlanningStatus)` 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.
`specificReservationRequired`	`boolean` 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.
`reservationName`	`string` 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.
`deploymentType`	`enum (DeploymentType)` Type of the deployment requested as part of future reservation.
`commitmentInfo`	`object (CommitmentInfo)` If not present, then FR will not deliver a new commitment or update an existing commitment.
`schedulingType`	`enum (SchedulingType)` Maintenance information for this reservation
`enableEmergentMaintenance`	`boolean` Indicates if this group of VMs have emergent maintenance enabled.
Union field `type`. `type` can be only one of the following:
`specificSkuProperties`	`object (SpecificSKUProperties)` Future Reservation configuration to indicate instance properties and total count.
`aggregateReservation`	`object (AggregateReservation)` Aggregate reservation details for 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 (Duration)` 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.

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 (TimeWindow)

Time window for this Future Reservation.

shareSettings

object (ShareSettings)

List of Projects/Folders to share with.

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 (Status)

[Output only] Status of the Future Reservation

planningStatus

enum (PlanningStatus)

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.

specificReservationRequired

boolean

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.

reservationName

string

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.

deploymentType

enum (DeploymentType)

Type of the deployment requested as part of future reservation.

commitmentInfo

object (CommitmentInfo)

If not present, then FR will not deliver a new commitment or update an existing commitment.

schedulingType

enum (SchedulingType)

Maintenance information for this reservation

enableEmergentMaintenance

boolean

Indicates if this group of VMs have emergent maintenance enabled.

Union field type.

type can be only one of the following:

specificSkuProperties

object (SpecificSKUProperties)

Future Reservation configuration to indicate instance properties and total count.

aggregateReservation

object (AggregateReservation)

Aggregate reservation details for 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 (Duration)

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.

SpecificSKUProperties

JSON representation
{ "instanceProperties": { object (`ReservedInstanceProperties`) }, "totalCount": string, "sourceInstanceTemplate": string }

Fields

Fields
`instanceProperties`	`object (ReservedInstanceProperties)` Properties of the SKU instances being reserved.
`totalCount`	`string (int64 format)` Total number of instances for which capacity assurance is requested at a future time period.
`sourceInstanceTemplate`	`string` The instance template that will be used to populate the ReservedInstanceProperties of the future reservation

instanceProperties

object (ReservedInstanceProperties)

Properties of the SKU instances being reserved.

totalCount

string (int64 format)

Total number of instances for which capacity assurance is requested at a future time period.

sourceInstanceTemplate

string

The instance template that will be used to populate the ReservedInstanceProperties of the future reservation

TimeWindow

JSON representation
{ "startTime": string, // Union field `time` can be only one of the following: "endTime": string, "duration": { object (`Duration`) } // End of list of possible types for union field `time`. }

Fields
`startTime`	`string` Start time of the Future Reservation. The startTime is an RFC3339 string.
Union field `time`. End time of the Future Reservation either in relative duration or calendar time. `time` can be only one of the following:
`endTime`	`string`
`duration`	`object (Duration)`

Status

[Output only] Represents status related to the future reservation.

JSON representation

JSON representation
{ "procurementStatus": enum (`ProcurementStatus`), "lockTime": string, "autoCreatedReservations": [ string ], "fulfilledCount": string, "specificSkuProperties": { object (`SpecificSKUProperties`) }, "amendmentStatus": enum (`AmendmentStatus`), "lastKnownGoodState": { object (`LastKnownGoodState`) }, "existingMatchingUsageInfo": { object (`ExistingMatchingUsageInfo`) } }

{
  "procurementStatus": enum (ProcurementStatus),
  "lockTime": string,
  "autoCreatedReservations": [
    string
  ],
  "fulfilledCount": string,
  "specificSkuProperties": {
    object (SpecificSKUProperties)
  },
  "amendmentStatus": enum (AmendmentStatus),
  "lastKnownGoodState": {
    object (LastKnownGoodState)
  },
  "existingMatchingUsageInfo": {
    object (ExistingMatchingUsageInfo)
  }
}

Fields
`procurementStatus`	`enum (ProcurementStatus)` Current state of this Future Reservation
`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.
`autoCreatedReservations[]`	`string` Fully qualified urls of the automatically created reservations at startTime.
`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.
`specificSkuProperties`	`object (SpecificSKUProperties)`
`amendmentStatus`	`enum (AmendmentStatus)` [Output Only] The current status of the requested amendment.
`lastKnownGoodState`	`object (LastKnownGoodState)` [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.
`existingMatchingUsageInfo`	`object (ExistingMatchingUsageInfo)` [Output Only] Represents the existing matching usage for the future reservation.

ProcurementStatus

Enums
`PROCUREMENT_STATUS_UNSPECIFIED`
`PENDING_APPROVAL`	Future reservation is pending approval by GCP.
`APPROVED`	Future reservation is approved by GCP.
`COMMITTED`	Future reservation is committed by the customer.
`DECLINED`	Future reservation is rejected by GCP.
`CANCELLED`	Future reservation is cancelled by the customer.
`PROCURING`	Future reservation is being procured by GCP. Beyond this point, Future reservation is locked and no further modifications are allowed.
`PROVISIONING`	Future reservation capacity is being provisioned. This state will be entered after startTime, while reservations are being created to provide totalCount reserved instance slots. This state will not persist past startTime + 24h.
`FULFILLED`	Future reservation is fulfilled completely.
`FAILED`	Future reservation failed. No additional reservations were provided.
`FAILED_PARTIALLY_FULFILLED`	Future reservation is partially fulfilled. Additional reservations were provided but did not reach totalCount reserved instance slots.
`DRAFTING`	Related status for PlanningStatus.Draft. Transitions to PENDING_APPROVAL upon user submitting FR.
`PENDING_AMENDMENT_APPROVAL`	An Amendment to the Future Reservation has been requested. If the Amendment is declined, the Future Reservation will be restored to the last known good state.

SpecificSKUProperties

Properties to be set for the Future Reservation.

JSON representation
{ "sourceInstanceTemplateId": string }

Fields

Fields
`sourceInstanceTemplateId`	`string` ID of the instance template used to populate the Future Reservation properties.

sourceInstanceTemplateId

string

ID of the instance template used to populate the Future Reservation properties.

AmendmentStatus

Enums
`AMENDMENT_STATUS_UNSPECIFIED`
`AMENDMENT_IN_REVIEW`	The requested amendment to the Future Reservation is currently being reviewd by GCP.
`AMENDMENT_APPROVED`	The requested amendment to the Future Resevation has been approved and applied by GCP.
`AMENDMENT_DECLINED`	The requested amendment to the Future Reservation has been declined by GCP and the original state was restored.

LastKnownGoodState

The state that the future reservation will be reverted to should the amendment be declined.

JSON representation

JSON representation
{ "futureReservationSpecs": { object (`FutureReservationSpecs`) }, "procurementStatus": enum (`ProcurementStatus`), "namePrefix": string, "description": string, "lockTime": string, "existingMatchingUsageInfo": { object (`ExistingMatchingUsageInfo`) } }

{
  "futureReservationSpecs": {
    object (FutureReservationSpecs)
  },
  "procurementStatus": enum (ProcurementStatus),
  "namePrefix": string,
  "description": string,
  "lockTime": string,
  "existingMatchingUsageInfo": {
    object (ExistingMatchingUsageInfo)
  }
}

Fields
`futureReservationSpecs`	`object (FutureReservationSpecs)`
`procurementStatus`	`enum (ProcurementStatus)` [Output Only] The status of the last known good state for the Future Reservation.
`namePrefix`	`string` [Output Only] The name prefix of the Future Reservation before an amendment was requested.
`description`	`string` [Output Only] The description of the FutureReservation before an amendment was requested.
`lockTime`	`string` [Output Only] The lock time of the FutureReservation before an amendment was requested.
`existingMatchingUsageInfo`	`object (ExistingMatchingUsageInfo)` [Output Only] Represents the matching usage for the future reservation before an amendment was requested.

FutureReservationSpecs

The properties of the last known good state for the Future Reservation.

JSON representation

JSON representation
{ "timeWindow": { object (`TimeWindow`) }, "shareSettings": { object (`ShareSettings`) }, // Union field `type` can be only one of the following: "specificSkuProperties": { object (`SpecificSKUProperties`) } // End of list of possible types for union field `type`. }

{
  "timeWindow": {
    object (TimeWindow)
  },
  "shareSettings": {
    object (ShareSettings)
  },

  // Union field type can be only one of the following:
  "specificSkuProperties": {
    object (SpecificSKUProperties)
  }
  // End of list of possible types for union field type.
}

Fields
`timeWindow`	`object (TimeWindow)` [Output Only] The previous time window of the Future Reservation.
`shareSettings`	`object (ShareSettings)` [Output Only] The previous share settings of the Future Reservation.
Union field `type`. `type` can be only one of the following:
`specificSkuProperties`	`object (SpecificSKUProperties)` [Output Only] The previous instance related properties of the Future Reservation.

ExistingMatchingUsageInfo

[Output Only] Represents the existing matching usage for the future reservation.

JSON representation
{ "count": string, "timestamp": string }

Fields

Fields
`count`	`string (int64 format)` Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)
`timestamp`	`string` Timestamp when the matching usage was calculated

count

string (int64 format)

Count to represent min(FR totalCount, matching_reserved_capacity+matching_unreserved_instances)

timestamp

string

Timestamp when the matching usage was calculated

PlanningStatus

Enums
`PLANNING_STATUS_UNSPECIFIED`
`DRAFT`	Future Reservation is being drafted.
`SUBMITTED`	Future Reservation has been submitted for evaluation by GCP.

CommitmentInfo

JSON representation
{ "commitmentPlan": enum (`Plan`), "commitmentName": string, "previousCommitmentTerms": enum (`PreviousCommitmentsTerm`) }

Fields

Fields
`commitmentPlan`	`enum (Plan)` 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.
`commitmentName`	`string` name of the commitment where capacity is being delivered to.
`previousCommitmentTerms`	`enum (PreviousCommitmentsTerm)` 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.

commitmentPlan

enum (Plan)

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.

commitmentName

string

name of the commitment where capacity is being delivered to.

previousCommitmentTerms

enum (PreviousCommitmentsTerm)

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.

PreviousCommitmentsTerm

Enums
`PREVIOUSCOMMITMENTTERM_UNSPECIFIED`	No changes to associated parents Committed Used Discount(s) terms.
`EXTEND`	All associated parent Committed Used Discount(s) end-date/term will be extended to the end-time of this future reservation. Default is to extend previous commitment(s) time to the endTime of the reservation.