Reservation (Compute Engine API beta-rev20220726-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.Reservation

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Reservation
extends GenericJson
```
Represents a reservation resource. A reservation ensures that capacity is held in a specific zone even if the reserved VMs are not running. For more information, read Reserving zonal resources.
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
  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

Reservation()

Constructors
Constructor and Description
`Reservation()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Reservation`	`clone()`
`String`	`getCommitment()` [Output Only] Full or partial URL to a parent commitment.
`String`	`getCreationTimestamp()` [Output Only] Creation timestamp in RFC3339 text format.
`String`	`getDescription()` An optional description of this resource.
`BigInteger`	`getId()` [Output Only] The unique identifier for the resource.
`String`	`getKind()` [Output Only] Type of the resource.
`String`	`getName()` The name of the resource, provided by the client when initially creating the resource.
`Boolean`	`getSatisfiesPzs()` [Output Only] Reserved for future use.
`String`	`getSelfLink()` [Output Only] Server-defined fully-qualified URL for this resource.
`ShareSettings`	`getShareSettings()` Share-settings for shared-reservation
`AllocationSpecificSKUReservation`	`getSpecificReservation()` Reservation for instances with specific machine shapes.
`Boolean`	`getSpecificReservationRequired()` Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation.
`String`	`getStatus()` [Output Only] The status of the reservation.
`String`	`getZone()` Zone in which the reservation resides.
`Reservation`	`set(String fieldName, Object value)`
`Reservation`	`setCommitment(String commitment)` [Output Only] Full or partial URL to a parent commitment.
`Reservation`	`setCreationTimestamp(String creationTimestamp)` [Output Only] Creation timestamp in RFC3339 text format.
`Reservation`	`setDescription(String description)` An optional description of this resource.
`Reservation`	`setId(BigInteger id)` [Output Only] The unique identifier for the resource.
`Reservation`	`setKind(String kind)` [Output Only] Type of the resource.
`Reservation`	`setName(String name)` The name of the resource, provided by the client when initially creating the resource.
`Reservation`	`setSatisfiesPzs(Boolean satisfiesPzs)` [Output Only] Reserved for future use.
`Reservation`	`setSelfLink(String selfLink)` [Output Only] Server-defined fully-qualified URL for this resource.
`Reservation`	`setShareSettings(ShareSettings shareSettings)` Share-settings for shared-reservation
`Reservation`	`setSpecificReservation(AllocationSpecificSKUReservation specificReservation)` Reservation for instances with specific machine shapes.
`Reservation`	`setSpecificReservationRequired(Boolean specificReservationRequired)` Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation.
`Reservation`	`setStatus(String status)` [Output Only] The status of the reservation.
`Reservation`	`setZone(String zone)` Zone in which the 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
  - Reservation
```
public Reservation()
```
- Method Detail
  - getCommitment
```
public String getCommitment()
```
    [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
    
    Returns:
    
    value or null for none
  - setCommitment
```
public Reservation setCommitment(String commitment)
```
    [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
    
    Parameters:
    
    commitment - commitment or null for none
  - getCreationTimestamp
```
public String getCreationTimestamp()
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Returns:
    
    value or null for none
  - setCreationTimestamp
```
public Reservation setCreationTimestamp(String creationTimestamp)
```
    [Output Only] Creation timestamp in RFC3339 text format.
    
    Parameters:
    
    creationTimestamp - creationTimestamp or null for none
  - getDescription
```
public String getDescription()
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Returns:
    
    value or null for none
  - setDescription
```
public Reservation setDescription(String description)
```
    An optional description of this resource. Provide this property when you create the resource.
    
    Parameters:
    
    description - description or null for none
  - getId
```
public BigInteger getId()
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Returns:
    
    value or null for none
  - setId
```
public Reservation setId(BigInteger id)
```
    [Output Only] The unique identifier for the resource. This identifier is defined by the server.
    
    Parameters:
    
    id - id or null for none
  - getKind
```
public String getKind()
```
    [Output Only] Type of the resource. Always compute#reservations for reservations.
    
    Returns:
    
    value or null for none
  - setKind
```
public Reservation setKind(String kind)
```
    [Output Only] Type of the resource. Always compute#reservations for 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 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.
    
    Returns:
    
    value or null for none
  - setName
```
public Reservation 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 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.
    
    Parameters:
    
    name - name or null for none
  - getSatisfiesPzs
```
public Boolean getSatisfiesPzs()
```
    [Output Only] Reserved for future use.
    
    Returns:
    
    value or null for none
  - setSatisfiesPzs
```
public Reservation setSatisfiesPzs(Boolean satisfiesPzs)
```
    [Output Only] Reserved for future use.
    
    Parameters:
    
    satisfiesPzs - satisfiesPzs 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 Reservation setSelfLink(String selfLink)
```
    [Output Only] Server-defined fully-qualified URL for this resource.
    
    Parameters:
    
    selfLink - selfLink or null for none
  - getShareSettings
```
public ShareSettings getShareSettings()
```
    Share-settings for shared-reservation
    
    Returns:
    
    value or null for none
  - setShareSettings
```
public Reservation setShareSettings(ShareSettings shareSettings)
```
    Share-settings for shared-reservation
    
    Parameters:
    
    shareSettings - shareSettings or null for none
  - getSpecificReservation
```
public AllocationSpecificSKUReservation getSpecificReservation()
```
    Reservation for instances with specific machine shapes.
    
    Returns:
    
    value or null for none
  - setSpecificReservation
```
public Reservation setSpecificReservation(AllocationSpecificSKUReservation specificReservation)
```
    Reservation for instances with specific machine shapes.
    
    Parameters:
    
    specificReservation - specificReservation or null for none
  - getSpecificReservationRequired
```
public Boolean getSpecificReservationRequired()
```
    Indicates whether the 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 this reservation.
    
    Returns:
    
    value or null for none
  - setSpecificReservationRequired
```
public Reservation setSpecificReservationRequired(Boolean specificReservationRequired)
```
    Indicates whether the 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 this reservation.
    
    Parameters:
    
    specificReservationRequired - specificReservationRequired or null for none
  - getStatus
```
public String getStatus()
```
    [Output Only] The status of the reservation.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Reservation setStatus(String status)
```
    [Output Only] The status of the reservation.
    
    Parameters:
    
    status - status or null for none
  - getZone
```
public String getZone()
```
    Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
    
    Returns:
    
    value or null for none
  - setZone
```
public Reservation setZone(String zone)
```
    Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
    
    Parameters:
    
    zone - zone or null for none
  - set
```
public Reservation set(String fieldName,
                       Object value)
```
    Overrides:
    
    set in class GenericJson
  - clone
```
public Reservation clone()
```
    Overrides:
    
    clone in class GenericJson

Class Reservation

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

Reservation

Method Detail

getCommitment

setCommitment

getCreationTimestamp

setCreationTimestamp

getDescription

setDescription

getId

setId

getKind

setKind

getName

setName

getSatisfiesPzs

setSatisfiesPzs

getSelfLink

setSelfLink

getShareSettings

setShareSettings

getSpecificReservation

setSpecificReservation

getSpecificReservationRequired

setSpecificReservationRequired

getStatus

setStatus

getZone

setZone

set

clone