Class Reservation (1.56.0)

public final class Reservation extends GeneratedMessageV3 implements ReservationOrBuilder

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.

Protobuf type google.cloud.compute.v1.Reservation

Static Fields

AGGREGATE_RESERVATION_FIELD_NUMBER

public static final int AGGREGATE_RESERVATION_FIELD_NUMBER
Field Value
Type Description
int

COMMITMENT_FIELD_NUMBER

public static final int COMMITMENT_FIELD_NUMBER
Field Value
Type Description
int

CREATION_TIMESTAMP_FIELD_NUMBER

public static final int CREATION_TIMESTAMP_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

KIND_FIELD_NUMBER

public static final int KIND_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_POLICIES_FIELD_NUMBER

public static final int RESOURCE_POLICIES_FIELD_NUMBER
Field Value
Type Description
int

RESOURCE_STATUS_FIELD_NUMBER

public static final int RESOURCE_STATUS_FIELD_NUMBER
Field Value
Type Description
int

SATISFIES_PZS_FIELD_NUMBER

public static final int SATISFIES_PZS_FIELD_NUMBER
Field Value
Type Description
int
public static final int SELF_LINK_FIELD_NUMBER
Field Value
Type Description
int

SHARE_SETTINGS_FIELD_NUMBER

public static final int SHARE_SETTINGS_FIELD_NUMBER
Field Value
Type Description
int

SPECIFIC_RESERVATION_FIELD_NUMBER

public static final int SPECIFIC_RESERVATION_FIELD_NUMBER
Field Value
Type Description
int

SPECIFIC_RESERVATION_REQUIRED_FIELD_NUMBER

public static final int SPECIFIC_RESERVATION_REQUIRED_FIELD_NUMBER
Field Value
Type Description
int

STATUS_FIELD_NUMBER

public static final int STATUS_FIELD_NUMBER
Field Value
Type Description
int

ZONE_FIELD_NUMBER

public static final int ZONE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Reservation getDefaultInstance()
Returns
Type Description
Reservation

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Reservation.Builder newBuilder()
Returns
Type Description
Reservation.Builder

newBuilder(Reservation prototype)

public static Reservation.Builder newBuilder(Reservation prototype)
Parameter
Name Description
prototype Reservation
Returns
Type Description
Reservation.Builder

parseDelimitedFrom(InputStream input)

public static Reservation parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Reservation
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Reservation parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Reservation
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Reservation parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Reservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Reservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Reservation parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Reservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Reservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Reservation parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Reservation
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Reservation
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Reservation parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Reservation
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Reservation
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Reservation parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Reservation
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Reservation parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Reservation
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Reservation> parser()
Returns
Type Description
Parser<Reservation>

Methods

containsResourcePolicies(String key)

public boolean containsResourcePolicies(String key)

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.

map<string, string> resource_policies = 22220385;

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAggregateReservation()

public AllocationAggregateReservation getAggregateReservation()

Reservation for aggregated resources, providing shape flexibility.

optional .google.cloud.compute.v1.AllocationAggregateReservation aggregate_reservation = 291567948;

Returns
Type Description
AllocationAggregateReservation

The aggregateReservation.

getAggregateReservationOrBuilder()

public AllocationAggregateReservationOrBuilder getAggregateReservationOrBuilder()

Reservation for aggregated resources, providing shape flexibility.

optional .google.cloud.compute.v1.AllocationAggregateReservation aggregate_reservation = 291567948;

Returns
Type Description
AllocationAggregateReservationOrBuilder

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.

optional string commitment = 482134805;

Returns
Type Description
String

The commitment.

getCommitmentBytes()

public ByteString getCommitmentBytes()

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

optional string commitment = 482134805;

Returns
Type Description
ByteString

The bytes for commitment.

getCreationTimestamp()

public String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDefaultInstanceForType()

public Reservation getDefaultInstanceForType()
Returns
Type Description
Reservation

getDescription()

public String getDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getId()

public long getId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public String getKind()

[Output Only] Type of the resource. Always compute#reservations for reservations.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public ByteString getKindBytes()

[Output Only] Type of the resource. Always compute#reservations for reservations.

optional string kind = 3292052;

Returns
Type Description
ByteString

The bytes for kind.

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? 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.

optional string name = 3373707;

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

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? 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.

optional string name = 3373707;

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Reservation> getParserForType()
Returns
Type Description
Parser<Reservation>
Overrides

getResourcePolicies() (deprecated)

public Map<String,String> getResourcePolicies()
Returns
Type Description
Map<String,String>

getResourcePoliciesCount()

public int getResourcePoliciesCount()

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.

map<string, string> resource_policies = 22220385;

Returns
Type Description
int

getResourcePoliciesMap()

public Map<String,String> getResourcePoliciesMap()

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.

map<string, string> resource_policies = 22220385;

Returns
Type Description
Map<String,String>

getResourcePoliciesOrDefault(String key, String defaultValue)

public String getResourcePoliciesOrDefault(String key, String defaultValue)

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.

map<string, string> resource_policies = 22220385;

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getResourcePoliciesOrThrow(String key)

public String getResourcePoliciesOrThrow(String key)

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.

map<string, string> resource_policies = 22220385;

Parameter
Name Description
key String
Returns
Type Description
String

getResourceStatus()

public AllocationResourceStatus getResourceStatus()

[Output Only] Status information for Reservation resource.

optional .google.cloud.compute.v1.AllocationResourceStatus resource_status = 249429315;

Returns
Type Description
AllocationResourceStatus

The resourceStatus.

getResourceStatusOrBuilder()

public AllocationResourceStatusOrBuilder getResourceStatusOrBuilder()

[Output Only] Status information for Reservation resource.

optional .google.cloud.compute.v1.AllocationResourceStatus resource_status = 249429315;

Returns
Type Description
AllocationResourceStatusOrBuilder

getSatisfiesPzs()

public boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

public String getSelfLink()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
String

The selfLink.

getSelfLinkBytes()

public ByteString getSelfLinkBytes()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;

Returns
Type Description
ShareSettings

The shareSettings.

getShareSettingsOrBuilder()

public ShareSettingsOrBuilder getShareSettingsOrBuilder()

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.

optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;

Returns
Type Description
ShareSettingsOrBuilder

getSpecificReservation()

public AllocationSpecificSKUReservation getSpecificReservation()

Reservation for instances with specific machine shapes.

optional .google.cloud.compute.v1.AllocationSpecificSKUReservation specific_reservation = 404901951;

Returns
Type Description
AllocationSpecificSKUReservation

The specificReservation.

getSpecificReservationOrBuilder()

public AllocationSpecificSKUReservationOrBuilder getSpecificReservationOrBuilder()

Reservation for instances with specific machine shapes.

optional .google.cloud.compute.v1.AllocationSpecificSKUReservation specific_reservation = 404901951;

Returns
Type Description
AllocationSpecificSKUReservationOrBuilder

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.

optional bool specific_reservation_required = 226550687;

Returns
Type Description
boolean

The specificReservationRequired.

getStatus()

public String getStatus()

[Output Only] The status of the reservation. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
String

The status.

getStatusBytes()

public ByteString getStatusBytes()

[Output Only] The status of the reservation. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
ByteString

The bytes for status.

getZone()

public String getZone()

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

optional string zone = 3744684;

Returns
Type Description
String

The zone.

getZoneBytes()

public ByteString getZoneBytes()

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

optional string zone = 3744684;

Returns
Type Description
ByteString

The bytes for zone.

hasAggregateReservation()

public boolean hasAggregateReservation()

Reservation for aggregated resources, providing shape flexibility.

optional .google.cloud.compute.v1.AllocationAggregateReservation aggregate_reservation = 291567948;

Returns
Type Description
boolean

Whether the aggregateReservation field is set.

hasCommitment()

public boolean hasCommitment()

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

optional string commitment = 482134805;

Returns
Type Description
boolean

Whether the commitment field is set.

hasCreationTimestamp()

public boolean hasCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDescription()

public boolean hasDescription()

An optional description of this resource. Provide this property when you create the resource.

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasId()

public boolean hasId()

[Output Only] The unique identifier for the resource. This identifier is defined by the server.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public boolean hasKind()

[Output Only] Type of the resource. Always compute#reservations for reservations.

optional string kind = 3292052;

Returns
Type Description
boolean

Whether the kind field is set.

hasName()

public boolean hasName()

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? 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.

optional string name = 3373707;

Returns
Type Description
boolean

Whether the name field is set.

hasResourceStatus()

public boolean hasResourceStatus()

[Output Only] Status information for Reservation resource.

optional .google.cloud.compute.v1.AllocationResourceStatus resource_status = 249429315;

Returns
Type Description
boolean

Whether the resourceStatus field is set.

hasSatisfiesPzs()

public boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

public boolean hasSelfLink()

[Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
boolean

Whether the selfLink field is set.

hasShareSettings()

public boolean hasShareSettings()

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.

optional .google.cloud.compute.v1.ShareSettings share_settings = 266668163;

Returns
Type Description
boolean

Whether the shareSettings field is set.

hasSpecificReservation()

public boolean hasSpecificReservation()

Reservation for instances with specific machine shapes.

optional .google.cloud.compute.v1.AllocationSpecificSKUReservation specific_reservation = 404901951;

Returns
Type Description
boolean

Whether the specificReservation field is set.

hasSpecificReservationRequired()

public boolean hasSpecificReservationRequired()

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.

optional bool specific_reservation_required = 226550687;

Returns
Type Description
boolean

Whether the specificReservationRequired field is set.

hasStatus()

public boolean hasStatus()

[Output Only] The status of the reservation. Check the Status enum for the list of possible values.

optional string status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hasZone()

public boolean hasZone()

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

optional string zone = 3744684;

Returns
Type Description
boolean

Whether the zone field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Reservation.Builder newBuilderForType()
Returns
Type Description
Reservation.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Reservation.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Reservation.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Reservation.Builder toBuilder()
Returns
Type Description
Reservation.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException