Interface FutureReservationOrBuilder (1.92.0)

public interface FutureReservationOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAggregateReservation()

public abstract AllocationAggregateReservation getAggregateReservation()

Aggregate reservation details for the future reservation.

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

Returns
Type Description
AllocationAggregateReservation

The aggregateReservation.

getAggregateReservationOrBuilder()

public abstract AllocationAggregateReservationOrBuilder getAggregateReservationOrBuilder()

Aggregate reservation details for the future reservation.

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

Returns
Type Description
AllocationAggregateReservationOrBuilder

getAutoCreatedReservationsDeleteTime()

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

optional string auto_created_reservations_delete_time = 242855120;

Returns
Type Description
String

The autoCreatedReservationsDeleteTime.

getAutoCreatedReservationsDeleteTimeBytes()

public abstract ByteString getAutoCreatedReservationsDeleteTimeBytes()

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.

optional string auto_created_reservations_delete_time = 242855120;

Returns
Type Description
ByteString

The bytes for autoCreatedReservationsDeleteTime.

getAutoCreatedReservationsDuration()

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

optional .google.cloud.compute.v1.Duration auto_created_reservations_duration = 496244741;

Returns
Type Description
Duration

The autoCreatedReservationsDuration.

getAutoCreatedReservationsDurationOrBuilder()

public abstract DurationOrBuilder getAutoCreatedReservationsDurationOrBuilder()

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.

optional .google.cloud.compute.v1.Duration auto_created_reservations_duration = 496244741;

Returns
Type Description
DurationOrBuilder

getAutoDeleteAutoCreatedReservations()

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

optional bool auto_delete_auto_created_reservations = 491352490;

Returns
Type Description
boolean

The autoDeleteAutoCreatedReservations.

getCommitmentInfo()

public abstract FutureReservationCommitmentInfo getCommitmentInfo()

If not present, then FR will not deliver a new commitment or update an existing commitment.

optional .google.cloud.compute.v1.FutureReservationCommitmentInfo commitment_info = 164362136;

Returns
Type Description
FutureReservationCommitmentInfo

The commitmentInfo.

getCommitmentInfoOrBuilder()

public abstract FutureReservationCommitmentInfoOrBuilder getCommitmentInfoOrBuilder()

If not present, then FR will not deliver a new commitment or update an existing commitment.

optional .google.cloud.compute.v1.FutureReservationCommitmentInfo commitment_info = 164362136;

Returns
Type Description
FutureReservationCommitmentInfoOrBuilder

getCreationTimestamp()

public abstract String getCreationTimestamp()

Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
String

The creationTimestamp.

getCreationTimestampBytes()

public abstract ByteString getCreationTimestampBytes()

Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
ByteString

The bytes for creationTimestamp.

getDeploymentType()

public abstract String getDeploymentType()

Type of the deployment requested as part of future reservation. Check the DeploymentType enum for the list of possible values.

optional string deployment_type = 396722292;

Returns
Type Description
String

The deploymentType.

getDeploymentTypeBytes()

public abstract ByteString getDeploymentTypeBytes()

Type of the deployment requested as part of future reservation. Check the DeploymentType enum for the list of possible values.

optional string deployment_type = 396722292;

Returns
Type Description
ByteString

The bytes for deploymentType.

getDescription()

public abstract String getDescription()

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

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 future reservation.

optional string description = 422937596;

Returns
Type Description
ByteString

The bytes for description.

getEnableEmergentMaintenance()

public abstract boolean getEnableEmergentMaintenance()

Indicates if this group of VMs have emergent maintenance enabled.

optional bool enable_emergent_maintenance = 353759497;

Returns
Type Description
boolean

The enableEmergentMaintenance.

getId()

public abstract long getId()

Output only. [Output Only] A unique identifier for this future reservation. The server defines this identifier.

optional uint64 id = 3355;

Returns
Type Description
long

The id.

getKind()

public abstract String getKind()

Output only. [Output Only] Type of the resource. Alwayscompute#futureReservation for future reservations.

optional string kind = 3292052;

Returns
Type Description
String

The kind.

getKindBytes()

public abstract ByteString getKindBytes()

Output only. [Output Only] Type of the resource. Alwayscompute#futureReservation for future 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 withRFC1035. 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 withRFC1035. 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.

getNamePrefix()

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

optional string name_prefix = 236409542;

Returns
Type Description
String

The namePrefix.

getNamePrefixBytes()

public abstract ByteString getNamePrefixBytes()

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

optional string name_prefix = 236409542;

Returns
Type Description
ByteString

The bytes for namePrefix.

getPlanningStatus()

public abstract String getPlanningStatus()

Planning state before being submitted for evaluation Check the PlanningStatus enum for the list of possible values.

optional string planning_status = 19714836;

Returns
Type Description
String

The planningStatus.

getPlanningStatusBytes()

public abstract ByteString getPlanningStatusBytes()

Planning state before being submitted for evaluation Check the PlanningStatus enum for the list of possible values.

optional string planning_status = 19714836;

Returns
Type Description
ByteString

The bytes for planningStatus.

getReservationMode()

public abstract String getReservationMode()

The reservation mode which determines reservation-termination behavior and expected pricing. Check the ReservationMode enum for the list of possible values.

optional string reservation_mode = 277294646;

Returns
Type Description
String

The reservationMode.

getReservationModeBytes()

public abstract ByteString getReservationModeBytes()

The reservation mode which determines reservation-termination behavior and expected pricing. Check the ReservationMode enum for the list of possible values.

optional string reservation_mode = 277294646;

Returns
Type Description
ByteString

The bytes for reservationMode.

getReservationName()

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

optional string reservation_name = 277311262;

Returns
Type Description
String

The reservationName.

getReservationNameBytes()

public abstract ByteString getReservationNameBytes()

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.

optional string reservation_name = 277311262;

Returns
Type Description
ByteString

The bytes for reservationName.

getSchedulingType()

public abstract String getSchedulingType()

Maintenance information for this reservation Check the SchedulingType enum for the list of possible values.

optional string scheduling_type = 199835397;

Returns
Type Description
String

The schedulingType.

getSchedulingTypeBytes()

public abstract ByteString getSchedulingTypeBytes()

Maintenance information for this reservation Check the SchedulingType enum for the list of possible values.

optional string scheduling_type = 199835397;

Returns
Type Description
ByteString

The bytes for schedulingType.

public abstract String getSelfLink()

Output only. [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. [Output Only] Server-defined fully-qualified URL for this resource.

optional string self_link = 456214797;

Returns
Type Description
ByteString

The bytes for selfLink.

getSelfLinkWithId()

public abstract String getSelfLinkWithId()

Output only. [Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
String

The selfLinkWithId.

getSelfLinkWithIdBytes()

public abstract ByteString getSelfLinkWithIdBytes()

Output only. [Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
ByteString

The bytes for selfLinkWithId.

getShareSettings()

public abstract ShareSettings getShareSettings()

List of Projects/Folders to share with.

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

Returns
Type Description
ShareSettings

The shareSettings.

getShareSettingsOrBuilder()

public abstract ShareSettingsOrBuilder getShareSettingsOrBuilder()

List of Projects/Folders to share with.

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

Returns
Type Description
ShareSettingsOrBuilder

getSpecificReservationRequired()

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

optional bool specific_reservation_required = 226550687;

Returns
Type Description
boolean

The specificReservationRequired.

getSpecificSkuProperties()

public abstract FutureReservationSpecificSKUProperties getSpecificSkuProperties()

Future Reservation configuration to indicate instance properties and total count.

optional .google.cloud.compute.v1.FutureReservationSpecificSKUProperties specific_sku_properties = 108887106;

Returns
Type Description
FutureReservationSpecificSKUProperties

The specificSkuProperties.

getSpecificSkuPropertiesOrBuilder()

public abstract FutureReservationSpecificSKUPropertiesOrBuilder getSpecificSkuPropertiesOrBuilder()

Future Reservation configuration to indicate instance properties and total count.

optional .google.cloud.compute.v1.FutureReservationSpecificSKUProperties specific_sku_properties = 108887106;

Returns
Type Description
FutureReservationSpecificSKUPropertiesOrBuilder

getStatus()

public abstract FutureReservationStatus getStatus()

Output only. [Output only] Status of the Future Reservation

optional .google.cloud.compute.v1.FutureReservationStatus status = 181260274;

Returns
Type Description
FutureReservationStatus

The status.

getStatusOrBuilder()

public abstract FutureReservationStatusOrBuilder getStatusOrBuilder()

Output only. [Output only] Status of the Future Reservation

optional .google.cloud.compute.v1.FutureReservationStatus status = 181260274;

Returns
Type Description
FutureReservationStatusOrBuilder

getTimeWindow()

public abstract FutureReservationTimeWindow getTimeWindow()

Time window for this Future Reservation.

optional .google.cloud.compute.v1.FutureReservationTimeWindow time_window = 422983074;

Returns
Type Description
FutureReservationTimeWindow

The timeWindow.

getTimeWindowOrBuilder()

public abstract FutureReservationTimeWindowOrBuilder getTimeWindowOrBuilder()

Time window for this Future Reservation.

optional .google.cloud.compute.v1.FutureReservationTimeWindow time_window = 422983074;

Returns
Type Description
FutureReservationTimeWindowOrBuilder

getZone()

public abstract String getZone()

Output only. [Output Only] URL of the Zone where this future reservation resides.

optional string zone = 3744684;

Returns
Type Description
String

The zone.

getZoneBytes()

public abstract ByteString getZoneBytes()

Output only. [Output Only] URL of the Zone where this future reservation resides.

optional string zone = 3744684;

Returns
Type Description
ByteString

The bytes for zone.

hasAggregateReservation()

public abstract boolean hasAggregateReservation()

Aggregate reservation details for the future reservation.

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

Returns
Type Description
boolean

Whether the aggregateReservation field is set.

hasAutoCreatedReservationsDeleteTime()

public abstract boolean hasAutoCreatedReservationsDeleteTime()

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.

optional string auto_created_reservations_delete_time = 242855120;

Returns
Type Description
boolean

Whether the autoCreatedReservationsDeleteTime field is set.

hasAutoCreatedReservationsDuration()

public abstract boolean hasAutoCreatedReservationsDuration()

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.

optional .google.cloud.compute.v1.Duration auto_created_reservations_duration = 496244741;

Returns
Type Description
boolean

Whether the autoCreatedReservationsDuration field is set.

hasAutoDeleteAutoCreatedReservations()

public abstract boolean hasAutoDeleteAutoCreatedReservations()

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.

optional bool auto_delete_auto_created_reservations = 491352490;

Returns
Type Description
boolean

Whether the autoDeleteAutoCreatedReservations field is set.

hasCommitmentInfo()

public abstract boolean hasCommitmentInfo()

If not present, then FR will not deliver a new commitment or update an existing commitment.

optional .google.cloud.compute.v1.FutureReservationCommitmentInfo commitment_info = 164362136;

Returns
Type Description
boolean

Whether the commitmentInfo field is set.

hasCreationTimestamp()

public abstract boolean hasCreationTimestamp()

Output only. [Output Only] The creation timestamp for this future reservation inRFC3339 text format.

optional string creation_timestamp = 30525366;

Returns
Type Description
boolean

Whether the creationTimestamp field is set.

hasDeploymentType()

public abstract boolean hasDeploymentType()

Type of the deployment requested as part of future reservation. Check the DeploymentType enum for the list of possible values.

optional string deployment_type = 396722292;

Returns
Type Description
boolean

Whether the deploymentType field is set.

hasDescription()

public abstract boolean hasDescription()

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

optional string description = 422937596;

Returns
Type Description
boolean

Whether the description field is set.

hasEnableEmergentMaintenance()

public abstract boolean hasEnableEmergentMaintenance()

Indicates if this group of VMs have emergent maintenance enabled.

optional bool enable_emergent_maintenance = 353759497;

Returns
Type Description
boolean

Whether the enableEmergentMaintenance field is set.

hasId()

public abstract boolean hasId()

Output only. [Output Only] A unique identifier for this future reservation. The server defines this identifier.

optional uint64 id = 3355;

Returns
Type Description
boolean

Whether the id field is set.

hasKind()

public abstract boolean hasKind()

Output only. [Output Only] Type of the resource. Alwayscompute#futureReservation for future 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 withRFC1035. 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.

hasNamePrefix()

public abstract boolean hasNamePrefix()

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

optional string name_prefix = 236409542;

Returns
Type Description
boolean

Whether the namePrefix field is set.

hasPlanningStatus()

public abstract boolean hasPlanningStatus()

Planning state before being submitted for evaluation Check the PlanningStatus enum for the list of possible values.

optional string planning_status = 19714836;

Returns
Type Description
boolean

Whether the planningStatus field is set.

hasReservationMode()

public abstract boolean hasReservationMode()

The reservation mode which determines reservation-termination behavior and expected pricing. Check the ReservationMode enum for the list of possible values.

optional string reservation_mode = 277294646;

Returns
Type Description
boolean

Whether the reservationMode field is set.

hasReservationName()

public abstract boolean hasReservationName()

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.

optional string reservation_name = 277311262;

Returns
Type Description
boolean

Whether the reservationName field is set.

hasSchedulingType()

public abstract boolean hasSchedulingType()

Maintenance information for this reservation Check the SchedulingType enum for the list of possible values.

optional string scheduling_type = 199835397;

Returns
Type Description
boolean

Whether the schedulingType field is set.

public abstract boolean hasSelfLink()

Output only. [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.

hasSelfLinkWithId()

public abstract boolean hasSelfLinkWithId()

Output only. [Output Only] Server-defined URL for this resource with the resource id.

optional string self_link_with_id = 44520962;

Returns
Type Description
boolean

Whether the selfLinkWithId field is set.

hasShareSettings()

public abstract boolean hasShareSettings()

List of Projects/Folders to share with.

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

Returns
Type Description
boolean

Whether the shareSettings field is set.

hasSpecificReservationRequired()

public abstract boolean hasSpecificReservationRequired()

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.

optional bool specific_reservation_required = 226550687;

Returns
Type Description
boolean

Whether the specificReservationRequired field is set.

hasSpecificSkuProperties()

public abstract boolean hasSpecificSkuProperties()

Future Reservation configuration to indicate instance properties and total count.

optional .google.cloud.compute.v1.FutureReservationSpecificSKUProperties specific_sku_properties = 108887106;

Returns
Type Description
boolean

Whether the specificSkuProperties field is set.

hasStatus()

public abstract boolean hasStatus()

Output only. [Output only] Status of the Future Reservation

optional .google.cloud.compute.v1.FutureReservationStatus status = 181260274;

Returns
Type Description
boolean

Whether the status field is set.

hasTimeWindow()

public abstract boolean hasTimeWindow()

Time window for this Future Reservation.

optional .google.cloud.compute.v1.FutureReservationTimeWindow time_window = 422983074;

Returns
Type Description
boolean

Whether the timeWindow field is set.

hasZone()

public abstract boolean hasZone()

Output only. [Output Only] URL of the Zone where this future reservation resides.

optional string zone = 3744684;

Returns
Type Description
boolean

Whether the zone field is set.