Compute V1 Client - Class FutureReservation (2.3.0)

Reference documentation and code samples for the Compute V1 Client class FutureReservation.

Generated from protobuf message google.cloud.compute.v1.FutureReservation

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ aggregate_reservation AllocationAggregateReservation

Aggregate reservation details for the future reservation.
↳ auto_created_reservations_delete_time string

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.
↳ auto_created_reservations_duration Duration

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.
↳ auto_delete_auto_created_reservations bool

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.
↳ commitment_info FutureReservationCommitmentInfo

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

[Output Only] The creation timestamp for this future reservation inRFC3339 text format.
↳ deployment_type string

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

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

Indicates if this group of VMs have emergent maintenance enabled.
↳ id int|string

[Output Only] A unique identifier for this future reservation. The server defines this identifier.
↳ kind string

[Output Only] Type of the resource. Alwayscompute#futureReservation for future reservations.
↳ name string

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]([-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.
↳ name_prefix string

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-####.
↳ planning_status string

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

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

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.
↳ scheduling_type string

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

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

[Output Only] Server-defined URL for this resource with the resource id.
↳ share_settings ShareSettings

List of Projects/Folders to share with.
↳ specific_reservation_required bool

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.
↳ specific_sku_properties FutureReservationSpecificSKUProperties

Future Reservation configuration to indicate instance properties and total count.
↳ status FutureReservationStatus

[Output only] Status of the Future Reservation
↳ time_window FutureReservationTimeWindow

Time window for this Future Reservation.
↳ zone string

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

getAggregateReservation

Aggregate reservation details for the future reservation.

Returns
Type Description
AllocationAggregateReservation|null

hasAggregateReservation

clearAggregateReservation

setAggregateReservation

Aggregate reservation details for the future reservation.

Parameter
Name Description
var AllocationAggregateReservation
Returns
Type Description
$this

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.

Returns
Type Description
string

hasAutoCreatedReservationsDeleteTime

clearAutoCreatedReservationsDeleteTime

setAutoCreatedReservationsDeleteTime

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.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
Duration|null

hasAutoCreatedReservationsDuration

clearAutoCreatedReservationsDuration

setAutoCreatedReservationsDuration

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.

Parameter
Name Description
var Duration
Returns
Type Description
$this

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.

Returns
Type Description
bool

hasAutoDeleteAutoCreatedReservations

clearAutoDeleteAutoCreatedReservations

setAutoDeleteAutoCreatedReservations

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getCommitmentInfo

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

Returns
Type Description
FutureReservationCommitmentInfo|null

hasCommitmentInfo

clearCommitmentInfo

setCommitmentInfo

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

Parameter
Name Description
var FutureReservationCommitmentInfo
Returns
Type Description
$this

getCreationTimestamp

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

Returns
Type Description
string

hasCreationTimestamp

clearCreationTimestamp

setCreationTimestamp

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

Parameter
Name Description
var string
Returns
Type Description
$this

getDeploymentType

Type of the deployment requested as part of future reservation.

Check the DeploymentType enum for the list of possible values.

Returns
Type Description
string

hasDeploymentType

clearDeploymentType

setDeploymentType

Type of the deployment requested as part of future reservation.

Check the DeploymentType enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

getDescription

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

Returns
Type Description
string

hasDescription

clearDescription

setDescription

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

Parameter
Name Description
var string
Returns
Type Description
$this

getEnableEmergentMaintenance

Indicates if this group of VMs have emergent maintenance enabled.

Returns
Type Description
bool

hasEnableEmergentMaintenance

clearEnableEmergentMaintenance

setEnableEmergentMaintenance

Indicates if this group of VMs have emergent maintenance enabled.

Parameter
Name Description
var bool
Returns
Type Description
$this

getId

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

Returns
Type Description
int|string

hasId

clearId

setId

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

Parameter
Name Description
var int|string
Returns
Type Description
$this

getKind

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

Returns
Type Description
string

hasKind

clearKind

setKind

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

Parameter
Name Description
var string
Returns
Type Description
$this

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]([-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
Type Description
string

hasName

clearName

setName

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]([-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.

Parameter
Name Description
var string
Returns
Type Description
$this

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

Returns
Type Description
string

hasNamePrefix

clearNamePrefix

setNamePrefix

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

Parameter
Name Description
var string
Returns
Type Description
$this

getPlanningStatus

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

Returns
Type Description
string

hasPlanningStatus

clearPlanningStatus

setPlanningStatus

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

Parameter
Name Description
var string
Returns
Type Description
$this

getReservationMode

The reservation mode which determines reservation-termination behavior and expected pricing.

Check the ReservationMode enum for the list of possible values.

Returns
Type Description
string

hasReservationMode

clearReservationMode

setReservationMode

The reservation mode which determines reservation-termination behavior and expected pricing.

Check the ReservationMode enum for the list of possible values.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
string

hasReservationName

clearReservationName

setReservationName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getSchedulingType

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

Returns
Type Description
string

hasSchedulingType

clearSchedulingType

setSchedulingType

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLink

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

Returns
Type Description
string

hasSelfLink

clearSelfLink

setSelfLink

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

Parameter
Name Description
var string
Returns
Type Description
$this

getSelfLinkWithId

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

Returns
Type Description
string

hasSelfLinkWithId

clearSelfLinkWithId

setSelfLinkWithId

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

Parameter
Name Description
var string
Returns
Type Description
$this

getShareSettings

List of Projects/Folders to share with.

Returns
Type Description
ShareSettings|null

hasShareSettings

clearShareSettings

setShareSettings

List of Projects/Folders to share with.

Parameter
Name Description
var ShareSettings
Returns
Type Description
$this

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.

Returns
Type Description
bool

hasSpecificReservationRequired

clearSpecificReservationRequired

setSpecificReservationRequired

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.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSpecificSkuProperties

Future Reservation configuration to indicate instance properties and total count.

Returns
Type Description
FutureReservationSpecificSKUProperties|null

hasSpecificSkuProperties

clearSpecificSkuProperties

setSpecificSkuProperties

Future Reservation configuration to indicate instance properties and total count.

Parameter
Name Description
var FutureReservationSpecificSKUProperties
Returns
Type Description
$this

getStatus

[Output only] Status of the Future Reservation

Returns
Type Description
FutureReservationStatus|null

hasStatus

clearStatus

setStatus

[Output only] Status of the Future Reservation

Parameter
Name Description
var FutureReservationStatus
Returns
Type Description
$this

getTimeWindow

Time window for this Future Reservation.

Returns
Type Description
FutureReservationTimeWindow|null

hasTimeWindow

clearTimeWindow

setTimeWindow

Time window for this Future Reservation.

Parameter
Name Description
var FutureReservationTimeWindow
Returns
Type Description
$this

getZone

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

Returns
Type Description
string

hasZone

clearZone

setZone

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

Parameter
Name Description
var string
Returns
Type Description
$this