Interface ReservationOrBuilder (1.63.0) 

public interface ReservationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

containsResourcePolicies(String key)

public abstract 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

getAggregateReservation()

public abstract 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 abstract AllocationAggregateReservationOrBuilder getAggregateReservationOrBuilder()

Reservation for aggregated resources, providing shape flexibility.

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

Returns
Type Description
AllocationAggregateReservationOrBuilder

getCommitment()

public abstract 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 abstract 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 abstract String getCreationTimestamp()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

[Output Only] Creation timestamp in RFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDescription()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getResourcePolicies() (deprecated)

public abstract Map<String,String> getResourcePolicies()

Use #getResourcePoliciesMap() instead.

Returns
Type Description
Map<String,String>

getResourcePoliciesCount()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract AllocationResourceStatusOrBuilder getResourceStatusOrBuilder()

[Output Only] Status information for Reservation resource.

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

Returns
Type Description
AllocationResourceStatusOrBuilder

getSatisfiesPzs()

public abstract boolean getSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

The satisfiesPzs.

getSelfLink()

public abstract 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 abstract 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.

getShareSettings()

public abstract 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 abstract 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 abstract 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 abstract AllocationSpecificSKUReservationOrBuilder getSpecificReservationOrBuilder()

Reservation for instances with specific machine shapes.

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

Returns
Type Description
AllocationSpecificSKUReservationOrBuilder

getSpecificReservationRequired()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract boolean hasSatisfiesPzs()

[Output Only] Reserved for future use.

optional bool satisfies_pzs = 480964267;

Returns
Type Description
boolean

Whether the satisfiesPzs field is set.

hasSelfLink()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.