com.google.api.services.compute.model

Class Reservation

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 com.google.api.client.json.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

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

Method Summary

Modifier and Type	Method and Description
Reservation	clone()
AllocationAggregateReservation	getAggregateReservation() Reservation for aggregated resources, providing shape flexibility.
String	getCommitment() [Output Only] Full or partial URL to a parent commitment.
String	getCreationTimestamp() [Output Only] Creation timestamp in RFC3339 text format.
Duration	getDeleteAfterDuration() Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
String	getDeleteAtTime() Absolute time in future when the reservation will be auto-deleted by Compute Engine.
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.
Map<String,String>	getResourcePolicies() Resource policies to be added to this reservation.
AllocationResourceStatus	getResourceStatus() [Output Only] Status information for Reservation resource.
Boolean	getSatisfiesPzs() [Output Only] Reserved for future use.
String	getSelfLink() [Output Only] Server-defined fully-qualified URL for this resource.
ShareSettings	getShareSettings() Specify share-settings to create a 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	setAggregateReservation(AllocationAggregateReservation aggregateReservation) Reservation for aggregated resources, providing shape flexibility.
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	setDeleteAfterDuration(Duration deleteAfterDuration) Duration time relative to reservation creation when Compute Engine will automatically delete this resource.
Reservation	setDeleteAtTime(String deleteAtTime) Absolute time in future when the reservation will be auto-deleted by Compute Engine.
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	setResourcePolicies(Map<String,String> resourcePolicies) Resource policies to be added to this reservation.
Reservation	setResourceStatus(AllocationResourceStatus resourceStatus) [Output Only] Status information for Reservation 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) Specify share-settings to create a 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

getAggregateReservation

public AllocationAggregateReservation getAggregateReservation()

Reservation for aggregated resources, providing shape flexibility.

Returns:

value or null for none

setAggregateReservation

public Reservation setAggregateReservation(AllocationAggregateReservation aggregateReservation)

Reservation for aggregated resources, providing shape flexibility.

Parameters:

aggregateReservation - aggregateReservation or null for none

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

getDeleteAfterDuration

public Duration getDeleteAfterDuration()

Duration time relative to reservation creation when Compute Engine will automatically delete this resource.

Returns:

value or null for none

setDeleteAfterDuration

public Reservation setDeleteAfterDuration(Duration deleteAfterDuration)

Duration time relative to reservation creation when Compute Engine will automatically delete this resource.

Parameters:

deleteAfterDuration - deleteAfterDuration or null for none

getDeleteAtTime

public String getDeleteAtTime()

Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.

Returns:

value or null for none

setDeleteAtTime

public Reservation setDeleteAtTime(String deleteAtTime)

Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented in RFC3339 text format.

Parameters:

deleteAtTime - deleteAtTime 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

getResourcePolicies

public Map<String,String> getResourcePolicies()

Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.

Returns:

value or null for none

setResourcePolicies

public Reservation setResourcePolicies(Map<String,String> resourcePolicies)

Resource policies to be added to this reservation. The key is defined by user, and the value is resource policy url. This is to define placement policy with reservation.

Parameters:

resourcePolicies - resourcePolicies or null for none

getResourceStatus

public AllocationResourceStatus getResourceStatus()

[Output Only] Status information for Reservation resource.

Returns:

value or null for none

setResourceStatus

public Reservation setResourceStatus(AllocationResourceStatus resourceStatus)

[Output Only] Status information for Reservation resource.

Parameters:

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

Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a shared reservation.

Returns:

value or null for none

setShareSettings

public Reservation setShareSettings(ShareSettings shareSettings)

Specify share-settings to create a shared reservation. This property is optional. For more information about the syntax and options for this field and its subfields, see the guide for creating a 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 com.google.api.client.json.GenericJson

clone

public Reservation clone()

Overrides:

clone in class com.google.api.client.json.GenericJson