FutureReservation (Compute Engine API v1-rev20250930-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.compute.model.FutureReservation

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class FutureReservation
extends com.google.api.client.json.GenericJson
```
Model definition for FutureReservation.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Compute Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

FutureReservation()

Constructors
Constructor and Description
`FutureReservation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FutureReservation`	`clone()`
`AllocationAggregateReservation`	`getAggregateReservation()` Aggregate reservation details for the future reservation.
`String`	`getAutoCreatedReservationsDeleteTime()` Future timestamp when the FR auto-created reservations will be deleted by Compute Engine.
`Duration`	`getAutoCreatedReservationsDuration()` Specifies the duration of auto-created reservations.
`Boolean`	`getAutoDeleteAutoCreatedReservations()` Setting for enabling or disabling automatic deletion for auto-created reservation.
`FutureReservationCommitmentInfo`	`getCommitmentInfo()` If not present, then FR will not deliver a new commitment or update an existing commitment.
`String`	`getCreationTimestamp()` [Output Only] The creation timestamp for this future reservation inRFC3339 text format.
`String`	`getDeploymentType()` Type of the deployment requested as part of future reservation.
`String`	`getDescription()` An optional description of this resource.
`Boolean`	`getEnableEmergentMaintenance()` Indicates if this group of VMs have emergent maintenance enabled.
`BigInteger`	`getId()` [Output Only] A unique identifier for this future reservation.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` The name of the resource, provided by the client when initially creating the resource.
`String`	`getNamePrefix()` Name prefix for the reservations to be created at the time of delivery.
`String`	`getPlanningStatus()` Planning state before being submitted for evaluation
`String`	`getReservationName()` Name of reservations where the capacity is provisioned at the time of delivery of future reservations.
`String`	`getSchedulingType()` Maintenance information for this reservation
`String`	`getSelfLink()` [Output Only] Server-defined fully-qualified URL for this resource.
`String`	`getSelfLinkWithId()` [Output Only] Server-defined URL for this resource with the resource id.
`ShareSettings`	`getShareSettings()` List of Projects/Folders to share with.
`Boolean`	`getSpecificReservationRequired()` Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation.
`FutureReservationSpecificSKUProperties`	`getSpecificSkuProperties()` Future Reservation configuration to indicate instance properties and total count.
`FutureReservationStatus`	`getStatus()` [Output only] Status of the Future Reservation
`FutureReservationTimeWindow`	`getTimeWindow()` Time window for this Future Reservation.
`String`	`getZone()` [Output Only] URL of the Zone where this future reservation resides.
`FutureReservation`	`set(String fieldName, Object value)`
`FutureReservation`	`setAggregateReservation(AllocationAggregateReservation aggregateReservation)` Aggregate reservation details for the future reservation.
`FutureReservation`	`setAutoCreatedReservationsDeleteTime(String autoCreatedReservationsDeleteTime)` Future timestamp when the FR auto-created reservations will be deleted by Compute Engine.
`FutureReservation`	`setAutoCreatedReservationsDuration(Duration autoCreatedReservationsDuration)` Specifies the duration of auto-created reservations.
`FutureReservation`	`setAutoDeleteAutoCreatedReservations(Boolean autoDeleteAutoCreatedReservations)` Setting for enabling or disabling automatic deletion for auto-created reservation.
`FutureReservation`	`setCommitmentInfo(FutureReservationCommitmentInfo commitmentInfo)` If not present, then FR will not deliver a new commitment or update an existing commitment.
`FutureReservation`	`setCreationTimestamp(String creationTimestamp)` [Output Only] The creation timestamp for this future reservation inRFC3339 text format.
`FutureReservation`	`setDeploymentType(String deploymentType)` Type of the deployment requested as part of future reservation.
`FutureReservation`	`setDescription(String description)` An optional description of this resource.
`FutureReservation`	`setEnableEmergentMaintenance(Boolean enableEmergentMaintenance)` Indicates if this group of VMs have emergent maintenance enabled.
`FutureReservation`	`setId(BigInteger id)` [Output Only] A unique identifier for this future reservation.
`FutureReservation`	`setKind(String kind)` [Output Only] Type of the resource.
`FutureReservation`	`setName(String name)` The name of the resource, provided by the client when initially creating the resource.
`FutureReservation`	`setNamePrefix(String namePrefix)` Name prefix for the reservations to be created at the time of delivery.
`FutureReservation`	`setPlanningStatus(String planningStatus)` Planning state before being submitted for evaluation
`FutureReservation`	`setReservationName(String reservationName)` Name of reservations where the capacity is provisioned at the time of delivery of future reservations.
`FutureReservation`	`setSchedulingType(String schedulingType)` Maintenance information for this reservation
`FutureReservation`	`setSelfLink(String selfLink)` [Output Only] Server-defined fully-qualified URL for this resource.
`FutureReservation`	`setSelfLinkWithId(String selfLinkWithId)` [Output Only] Server-defined URL for this resource with the resource id.
`FutureReservation`	`setShareSettings(ShareSettings shareSettings)` List of Projects/Folders to share with.
`FutureReservation`	`setSpecificReservationRequired(Boolean specificReservationRequired)` Indicates whether the auto-created reservation can be consumed by VMs with affinity for "any" reservation.
`FutureReservation`	`setSpecificSkuProperties(FutureReservationSpecificSKUProperties specificSkuProperties)` Future Reservation configuration to indicate instance properties and total count.
`FutureReservation`	`setStatus(FutureReservationStatus status)` [Output only] Status of the Future Reservation
`FutureReservation`	`setTimeWindow(FutureReservationTimeWindow timeWindow)` Time window for this Future Reservation.
`FutureReservation`	`setZone(String zone)` [Output Only] URL of the Zone where this future reservation resides.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - FutureReservation
```
public FutureReservation()
```
- Method Detail
  - getAggregateReservation
```
public AllocationAggregateReservation getAggregateReservation()
```
    Aggregate reservation details for the future reservation.
    
    Returns:
    
    value or null for none
  - setAggregateReservation
```
public FutureReservation setAggregateReservation(AllocationAggregateReservation aggregateReservation)
```
    Aggregate reservation details for the future reservation.
    
    Parameters:
    
    aggregateReservation - aggregateReservation or null for none
  - getAutoCreatedReservationsDeleteTime
```
public String getAutoCreatedReservationsDeleteTime()
```
    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.
    
    Returns:
    
    value or null for none
  - setAutoCreatedReservationsDeleteTime
```
public FutureReservation setAutoCreatedReservationsDeleteTime(String autoCreatedReservationsDeleteTime)
```
    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.
    
    Parameters:
    
    autoCreatedReservationsDeleteTime - autoCreatedReservationsDeleteTime or null for none
  - getAutoCreatedReservationsDuration
```
public Duration getAutoCreatedReservationsDuration()
```
    Specifies the duration of auto-created reservations. It represents relative time to future reservation start_time 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.
    
    Returns:
    
    value or null for none
  - setAutoCreatedReservationsDuration
```
public FutureReservation setAutoCreatedReservationsDuration(Duration autoCreatedReservationsDuration)
```
    Specifies the duration of auto-created reservations. It represents relative time to future reservation start_time 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.
    
    Parameters:
    
    autoCreatedReservationsDuration - autoCreatedReservationsDuration or null for none
  - getAutoDeleteAutoCreatedReservations
```
public Boolean getAutoDeleteAutoCreatedReservations()
```
    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.
    
    Returns:
    
    value or null for none
  - setAutoDeleteAutoCreatedReservations
```
public FutureReservation setAutoDeleteAutoCreatedReservations(Boolean autoDeleteAutoCreatedReservations)
```
    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.
    
    Parameters:
    
    autoDeleteAutoCreatedReservations - autoDeleteAutoCreatedReservations or null for none
  - getCommitmentInfo
```
public FutureReservationCommitmentInfo getCommitmentInfo()
```
    If not present, then FR will not deliver a new commitment or update an existing commitment.
    
    Returns:
    
    value or null for none
  - setCommitmentInfo
```
public FutureReservation setCommitmentInfo(FutureReservationCommitmentInfo commitmentInfo)
```
    If not present, then FR will not deliver a new commitment or update an existing commitment.
    
    Parameters:
    
    commitmentInfo - commitmentInfo or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] The creation timestamp for this future reservation inRFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public FutureReservation setCreationTimestamp(String creationTimestamp)
```
    [Output Only] The creation timestamp for this future reservation inRFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDeploymentType
```
public String getDeploymentType()
```
    Type of the deployment requested as part of future reservation.
    
    Returns:
    
    value or null for none
  - setDeploymentType
```
public FutureReservation setDeploymentType(String deploymentType)
```
    Type of the deployment requested as part of future reservation.
    
    Parameters:
    
    deploymentType - deploymentType or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the future reservation.
    
    Returns:
    
    value or null for none
  - setDescription
```
public FutureReservation setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the future reservation.
    
    Parameters:
    
    description - description or null for none
  - getEnableEmergentMaintenance
```
public Boolean getEnableEmergentMaintenance()
```
    Indicates if this group of VMs have emergent maintenance enabled.
    
    Returns:
    
    value or null for none
  - setEnableEmergentMaintenance
```
public FutureReservation setEnableEmergentMaintenance(Boolean enableEmergentMaintenance)
```
    Indicates if this group of VMs have emergent maintenance enabled.
    
    Parameters:
    
    enableEmergentMaintenance - enableEmergentMaintenance or null for none
  - getId
```
public BigInteger getId()
```
    [Output Only] A unique identifier for this future reservation. The server defines this identifier.
    
    Returns:
    
    value or null for none
  - setId
```
public FutureReservation setId(BigInteger id)
```
    [Output Only] A unique identifier for this future reservation. The server defines this identifier.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Alwayscompute#futureReservation for future reservations.
    
    Returns:
    
    value or null for none
  - setKind
```
public FutureReservation setKind(String kind)
```
    [Output Only] Type of the resource. Alwayscompute#futureReservation for future reservations.
    
    Parameters:
    
    kind - kind or null for none
  - getName
```
public String getName()
```
    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.
    
    Returns:
    
    value or null for none
  - setName
```
public FutureReservation setName(String name)
```
    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.
    
    Parameters:
    
    name - name or null for none
  - getNamePrefix
```
public String getNamePrefix()
```
    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-####.
    
    Returns:
    
    value or null for none
  - setNamePrefix
```
public FutureReservation setNamePrefix(String namePrefix)
```
    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-####.
    
    Parameters:
    
    namePrefix - namePrefix or null for none
  - getPlanningStatus
```
public String getPlanningStatus()
```
    Planning state before being submitted for evaluation
    
    Returns:
    
    value or null for none
  - setPlanningStatus
```
public FutureReservation setPlanningStatus(String planningStatus)
```
    Planning state before being submitted for evaluation
    
    Parameters:
    
    planningStatus - planningStatus or null for none
  - getReservationName
```
public String getReservationName()
```
    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.
    
    Returns:
    
    value or null for none
  - setReservationName
```
public FutureReservation setReservationName(String reservationName)
```
    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.
    
    Parameters:
    
    reservationName - reservationName or null for none
  - getSchedulingType
```
public String getSchedulingType()
```
    Maintenance information for this reservation
    
    Returns:
    
    value or null for none
  - setSchedulingType
```
public FutureReservation setSchedulingType(String schedulingType)
```
    Maintenance information for this reservation
    
    Parameters:
    
    schedulingType - schedulingType or null for none
  - getSelfLink
```
public String getSelfLink()
```
    [Output Only] Server-defined fully-qualified URL for this resource.
    
    Returns:
    
    value or null for none
  - setSelfLink
```
public FutureReservation setSelfLink(String selfLink)
```
    [Output Only] Server-defined fully-qualified URL for this resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getSelfLinkWithId
```
public String getSelfLinkWithId()
```
    [Output Only] Server-defined URL for this resource with the resource id.
    
    Returns:
    
    value or null for none
  - setSelfLinkWithId
```
public FutureReservation setSelfLinkWithId(String selfLinkWithId)
```
    [Output Only] Server-defined URL for this resource with the resource id.
    
    Parameters:
    
    selfLinkWithId - selfLinkWithId or null for none
  - getShareSettings
```
public ShareSettings getShareSettings()
```
    List of Projects/Folders to share with.
    
    Returns:
    
    value or null for none
  - setShareSettings
```
public FutureReservation setShareSettings(ShareSettings shareSettings)
```
    List of Projects/Folders to share with.
    
    Parameters:
    
    shareSettings - shareSettings or null for none
  - getSpecificReservationRequired
```
public Boolean getSpecificReservationRequired()
```
    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.
    
    Returns:
    
    value or null for none
  - setSpecificReservationRequired
```
public FutureReservation setSpecificReservationRequired(Boolean specificReservationRequired)
```
    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.
    
    Parameters:
    
    specificReservationRequired - specificReservationRequired or null for none
  - getSpecificSkuProperties
```
public FutureReservationSpecificSKUProperties getSpecificSkuProperties()
```
    Future Reservation configuration to indicate instance properties and total count.
    
    Returns:
    
    value or null for none
  - setSpecificSkuProperties
```
public FutureReservation setSpecificSkuProperties(FutureReservationSpecificSKUProperties specificSkuProperties)
```
    Future Reservation configuration to indicate instance properties and total count.
    
    Parameters:
    
    specificSkuProperties - specificSkuProperties or null for none
  - getStatus
```
public FutureReservationStatus getStatus()
```
    [Output only] Status of the Future Reservation
    
    Returns:
    
    value or null for none
  - setStatus
```
public FutureReservation setStatus(FutureReservationStatus status)
```
    [Output only] Status of the Future Reservation
    
    Parameters:
    
    status - status or null for none
  - getTimeWindow
```
public FutureReservationTimeWindow getTimeWindow()
```
    Time window for this Future Reservation.
    
    Returns:
    
    value or null for none
  - setTimeWindow
```
public FutureReservation setTimeWindow(FutureReservationTimeWindow timeWindow)
```
    Time window for this Future Reservation.
    
    Parameters:
    
    timeWindow - timeWindow or null for none
  - getZone
```
public String getZone()
```
    [Output Only] URL of the Zone where this future reservation resides.
    
    Returns:
    
    value or null for none
  - setZone
```
public FutureReservation setZone(String zone)
```
    [Output Only] URL of the Zone where this future reservation resides.
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public FutureReservation set(String fieldName,
                             Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public FutureReservation clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class FutureReservation

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

FutureReservation

Method Detail

getAggregateReservation

setAggregateReservation

getAutoCreatedReservationsDeleteTime

setAutoCreatedReservationsDeleteTime

getAutoCreatedReservationsDuration

setAutoCreatedReservationsDuration

getAutoDeleteAutoCreatedReservations

setAutoDeleteAutoCreatedReservations

getCommitmentInfo

setCommitmentInfo

getCreationTimestamp

setCreationTimestamp

getDeploymentType

setDeploymentType

getDescription

setDescription

getEnableEmergentMaintenance

setEnableEmergentMaintenance

getId

setId

getKind

setKind

getName

setName

getNamePrefix

setNamePrefix

getPlanningStatus

setPlanningStatus

getReservationName

setReservationName

getSchedulingType

setSchedulingType

getSelfLink

setSelfLink

getSelfLinkWithId

setSelfLinkWithId

getShareSettings

setShareSettings

getSpecificReservationRequired

setSpecificReservationRequired

getSpecificSkuProperties

setSpecificSkuProperties

getStatus

setStatus

getTimeWindow

setTimeWindow

getZone

setZone

set

clone