# Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::FutureReservation (v3.7.0)

3.7.0 (latest) 3.6.0 3.5.0 3.4.0 3.3.0 3.2.0 3.1.0 3.0.0 2.22.0 2.21.1 2.20.0 2.19.1 2.18.0 2.17.0 2.16.0 2.15.0 2.14.0 2.13.0 2.12.0 2.11.0 2.10.0 2.9.0 2.8.0 2.7.2 2.6.0 2.5.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.10.0 1.9.0 1.8.0 1.7.1 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.5.0 Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::FutureReservation.

## Inherits

- Object

## Extended By

- Google::Protobuf::MessageExts::ClassMethods

## Includes

- Google::Protobuf::MessageExts

## Methods

### #aggregate_reservation

    def aggregate_reservation() -> ::Google::Cloud::Compute::V1::AllocationAggregateReservation

**Returns**

- ([::Google::Cloud::Compute::V1::AllocationAggregateReservation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AllocationAggregateReservation)) --- Aggregate reservation details for the future reservation.

### #aggregate_reservation=

    def aggregate_reservation=(value) -> ::Google::Cloud::Compute::V1::AllocationAggregateReservation

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::AllocationAggregateReservation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AllocationAggregateReservation)) --- Aggregate reservation details for the future reservation.
**Returns**

- ([::Google::Cloud::Compute::V1::AllocationAggregateReservation](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-AllocationAggregateReservation)) --- Aggregate reservation details for the future reservation.

### #auto_created_reservations_delete_time

    def auto_created_reservations_delete_time() -> ::String

**Returns**

- (::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_delete_time=

    def auto_created_reservations_delete_time=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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

    def auto_created_reservations_duration() -> ::Google::Cloud::Compute::V1::Duration

**Returns**

- ([::Google::Cloud::Compute::V1::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-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_created_reservations_duration=

    def auto_created_reservations_duration=(value) -> ::Google::Cloud::Compute::V1::Duration

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-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.
**Returns**

- ([::Google::Cloud::Compute::V1::Duration](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-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

    def auto_delete_auto_created_reservations() -> ::Boolean

**Returns**

- (::Boolean) --- 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.

### #auto_delete_auto_created_reservations=

    def auto_delete_auto_created_reservations=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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**

- (::Boolean) --- 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

    def commitment_info() -> ::Google::Cloud::Compute::V1::FutureReservationCommitmentInfo

**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationCommitmentInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationCommitmentInfo)) --- If not present, then FR will not deliver a new commitment or update an existing commitment.

### #commitment_info=

    def commitment_info=(value) -> ::Google::Cloud::Compute::V1::FutureReservationCommitmentInfo

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::FutureReservationCommitmentInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationCommitmentInfo)) --- If not present, then FR will not deliver a new commitment or update an existing commitment.
**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationCommitmentInfo](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationCommitmentInfo)) --- If not present, then FR will not deliver a new commitment or update an existing commitment.

### #confidential_compute_type

    def confidential_compute_type() -> ::String

**Returns**

- (::String) --- Check the ConfidentialComputeType enum for the list of possible values.

### #confidential_compute_type=

    def confidential_compute_type=(value) -> ::String

**Parameter**

- **value** (::String) --- Check the ConfidentialComputeType enum for the list of possible values.
**Returns**

- (::String) --- Check the ConfidentialComputeType enum for the list of possible values.

### #creation_timestamp

    def creation_timestamp() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] The creation timestamp for this future reservation inRFC3339 text format.

### #creation_timestamp=

    def creation_timestamp=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] The creation timestamp for this future reservation inRFC3339 text format.
**Returns**

- (::String) --- Output only. \[Output Only\] The creation timestamp for this future reservation inRFC3339 text format.

### #deployment_type

    def deployment_type() -> ::String

**Returns**

- (::String) --- Type of the deployment requested as part of future reservation. Check the DeploymentType enum for the list of possible values.

### #deployment_type=

    def deployment_type=(value) -> ::String

**Parameter**

- **value** (::String) --- Type of the deployment requested as part of future reservation. Check the DeploymentType enum for the list of possible values.
**Returns**

- (::String) --- Type of the deployment requested as part of future reservation. Check the DeploymentType enum for the list of possible values.

### #description

    def description() -> ::String

**Returns**

- (::String) --- An optional description of this resource. Provide this property when you create the future reservation.

### #description=

    def description=(value) -> ::String

**Parameter**

- **value** (::String) --- An optional description of this resource. Provide this property when you create the future reservation.
**Returns**

- (::String) --- An optional description of this resource. Provide this property when you create the future reservation.

### #enable_emergent_maintenance

    def enable_emergent_maintenance() -> ::Boolean

**Returns**

- (::Boolean) --- Indicates if this group of VMs have emergent maintenance enabled.

### #enable_emergent_maintenance=

    def enable_emergent_maintenance=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- Indicates if this group of VMs have emergent maintenance enabled.
**Returns**

- (::Boolean) --- Indicates if this group of VMs have emergent maintenance enabled.

### #id

    def id() -> ::Integer

**Returns**

- (::Integer) --- Output only. \[Output Only\] A unique identifier for this future reservation. The server defines this identifier.

### #id=

    def id=(value) -> ::Integer

**Parameter**

- **value** (::Integer) --- Output only. \[Output Only\] A unique identifier for this future reservation. The server defines this identifier.
**Returns**

- (::Integer) --- Output only. \[Output Only\] A unique identifier for this future reservation. The server defines this identifier.

### #kind

    def kind() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] Type of the resource. Alwayscompute#futureReservation for future reservations.

### #kind=

    def kind=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] Type of the resource. Alwayscompute#futureReservation for future reservations.
**Returns**

- (::String) --- Output only. \[Output Only\] Type of the resource. Alwayscompute#futureReservation for future reservations.

### #name

    def name() -> ::String

**Returns**

- (::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=

    def name=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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

    def name_prefix() -> ::String

**Returns**

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

### #name_prefix=

    def name_prefix=(value) -> ::String

**Parameter**

- **value** (::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-####.
**Returns**

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

### #params

    def params() -> ::Google::Cloud::Compute::V1::FutureReservationParams

**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationParams)) --- Input only. Additional params passed with the request, but not persisted as part of resource payload.

### #params=

    def params=(value) -> ::Google::Cloud::Compute::V1::FutureReservationParams

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::FutureReservationParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationParams)) --- Input only. Additional params passed with the request, but not persisted as part of resource payload.
**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationParams](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationParams)) --- Input only. Additional params passed with the request, but not persisted as part of resource payload.

### #planning_status

    def planning_status() -> ::String

**Returns**

- (::String) --- Planning state before being submitted for evaluation Check the PlanningStatus enum for the list of possible values.

### #planning_status=

    def planning_status=(value) -> ::String

**Parameter**

- **value** (::String) --- Planning state before being submitted for evaluation Check the PlanningStatus enum for the list of possible values.
**Returns**

- (::String) --- Planning state before being submitted for evaluation Check the PlanningStatus enum for the list of possible values.

### #reservation_mode

    def reservation_mode() -> ::String

**Returns**

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

### #reservation_mode=

    def reservation_mode=(value) -> ::String

**Parameter**

- **value** (::String) --- The reservation mode which determines reservation-termination behavior and expected pricing. Check the ReservationMode enum for the list of possible values.
**Returns**

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

### #reservation_name

    def reservation_name() -> ::String

**Returns**

- (::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.

### #reservation_name=

    def reservation_name=(value) -> ::String

**Parameter**

- **value** (::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.
**Returns**

- (::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

    def scheduling_type() -> ::String

**Returns**

- (::String) --- Maintenance information for this reservation Check the SchedulingType enum for the list of possible values.

### #scheduling_type=

    def scheduling_type=(value) -> ::String

**Parameter**

- **value** (::String) --- Maintenance information for this reservation Check the SchedulingType enum for the list of possible values.
**Returns**

- (::String) --- Maintenance information for this reservation Check the SchedulingType enum for the list of possible values.

### #self_link

    def self_link() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined fully-qualified URL for this resource.

### #self_link=

    def self_link=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] Server-defined fully-qualified URL for this resource.
**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined fully-qualified URL for this resource.

### #self_link_with_id

    def self_link_with_id() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined URL for this resource with the resource id.

### #self_link_with_id=

    def self_link_with_id=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] Server-defined URL for this resource with the resource id.
**Returns**

- (::String) --- Output only. \[Output Only\] Server-defined URL for this resource with the resource id.

### #share_settings

    def share_settings() -> ::Google::Cloud::Compute::V1::ShareSettings

**Returns**

- ([::Google::Cloud::Compute::V1::ShareSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ShareSettings)) --- List of Projects/Folders to share with.

### #share_settings=

    def share_settings=(value) -> ::Google::Cloud::Compute::V1::ShareSettings

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::ShareSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ShareSettings)) --- List of Projects/Folders to share with.
**Returns**

- ([::Google::Cloud::Compute::V1::ShareSettings](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-ShareSettings)) --- List of Projects/Folders to share with.

### #specific_reservation_required

    def specific_reservation_required() -> ::Boolean

**Returns**

- (::Boolean) --- 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_reservation_required=

    def specific_reservation_required=(value) -> ::Boolean

**Parameter**

- **value** (::Boolean) --- 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**

- (::Boolean) --- 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

    def specific_sku_properties() -> ::Google::Cloud::Compute::V1::FutureReservationSpecificSKUProperties

**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationSpecificSKUProperties](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationSpecificSKUProperties)) --- Future Reservation configuration to indicate instance properties and total count.

### #specific_sku_properties=

    def specific_sku_properties=(value) -> ::Google::Cloud::Compute::V1::FutureReservationSpecificSKUProperties

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::FutureReservationSpecificSKUProperties](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationSpecificSKUProperties)) --- Future Reservation configuration to indicate instance properties and total count.
**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationSpecificSKUProperties](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationSpecificSKUProperties)) --- Future Reservation configuration to indicate instance properties and total count.

### #status

    def status() -> ::Google::Cloud::Compute::V1::FutureReservationStatus

**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationStatus](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationStatus)) --- Output only. \[Output only\] Status of the Future Reservation

### #status=

    def status=(value) -> ::Google::Cloud::Compute::V1::FutureReservationStatus

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::FutureReservationStatus](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationStatus)) --- Output only. \[Output only\] Status of the Future Reservation
**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationStatus](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationStatus)) --- Output only. \[Output only\] Status of the Future Reservation

### #time_window

    def time_window() -> ::Google::Cloud::Compute::V1::FutureReservationTimeWindow

**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationTimeWindow](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationTimeWindow)) --- Time window for this Future Reservation.

### #time_window=

    def time_window=(value) -> ::Google::Cloud::Compute::V1::FutureReservationTimeWindow

**Parameter**

- **value** ([::Google::Cloud::Compute::V1::FutureReservationTimeWindow](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationTimeWindow)) --- Time window for this Future Reservation.
**Returns**

- ([::Google::Cloud::Compute::V1::FutureReservationTimeWindow](https://docs.cloud.google.com/ruby/docs/reference/google-cloud-compute-v1/latest/Google-Cloud-Compute-V1-FutureReservationTimeWindow)) --- Time window for this Future Reservation.

### #zone

    def zone() -> ::String

**Returns**

- (::String) --- Output only. \[Output Only\] URL of the Zone where this future reservation resides.

### #zone=

    def zone=(value) -> ::String

**Parameter**

- **value** (::String) --- Output only. \[Output Only\] URL of the Zone where this future reservation resides.
**Returns**

- (::String) --- Output only. \[Output Only\] URL of the Zone where this future reservation resides.