Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Reservation (v3.5.0)

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Reservation.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#advanced_deployment_control

def advanced_deployment_control() -> ::Google::Cloud::Compute::V1::ReservationAdvancedDeploymentControl
Returns

#advanced_deployment_control=

def advanced_deployment_control=(value) -> ::Google::Cloud::Compute::V1::ReservationAdvancedDeploymentControl
Parameter
Returns

#aggregate_reservation

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

#aggregate_reservation=

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

#commitment

def commitment() -> ::String
Returns
  • (::String) — Output only. [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

#commitment=

def commitment=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
Returns
  • (::String) — Output only. [Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.

#creation_timestamp

def creation_timestamp() -> ::String
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#creation_timestamp=

def creation_timestamp=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.
Returns
  • (::String) — Output only. [Output Only] Creation timestamp inRFC3339 text format.

#delete_after_duration

def delete_after_duration() -> ::Google::Cloud::Compute::V1::Duration
Returns

#delete_after_duration=

def delete_after_duration=(value) -> ::Google::Cloud::Compute::V1::Duration
Parameter
Returns

#delete_at_time

def delete_at_time() -> ::String
Returns
  • (::String) — Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.

#delete_at_time=

def delete_at_time=(value) -> ::String
Parameter
  • value (::String) — Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.
Returns
  • (::String) — Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format.

#deployment_type

def deployment_type() -> ::String
Returns
  • (::String) — Specifies the deployment strategy for this reservation. Check the DeploymentType enum for the list of possible values.

#deployment_type=

def deployment_type=(value) -> ::String
Parameter
  • value (::String) — Specifies the deployment strategy for this reservation. Check the DeploymentType enum for the list of possible values.
Returns
  • (::String) — Specifies the deployment strategy for this 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 resource.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — An optional description of this resource. Provide this property when you create the resource.
Returns
  • (::String) — An optional description of this resource. Provide this property when you create the resource.

#early_access_maintenance

def early_access_maintenance() -> ::String
Returns
  • (::String) — Indicates the early access maintenance for the reservation. If this field is absent or set to NO_EARLY_ACCESS, the reservation is not enrolled in early access maintenance and the standard notice applies. Check the EarlyAccessMaintenance enum for the list of possible values.

#early_access_maintenance=

def early_access_maintenance=(value) -> ::String
Parameter
  • value (::String) — Indicates the early access maintenance for the reservation. If this field is absent or set to NO_EARLY_ACCESS, the reservation is not enrolled in early access maintenance and the standard notice applies. Check the EarlyAccessMaintenance enum for the list of possible values.
Returns
  • (::String) — Indicates the early access maintenance for the reservation. If this field is absent or set to NO_EARLY_ACCESS, the reservation is not enrolled in early access maintenance and the standard notice applies. Check the EarlyAccessMaintenance enum for the list of possible values.

#enable_emergent_maintenance

def enable_emergent_maintenance() -> ::Boolean
Returns
  • (::Boolean) — Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors.

#enable_emergent_maintenance=

def enable_emergent_maintenance=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors.
Returns
  • (::Boolean) — Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors.

#id

def id() -> ::Integer
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#id=

def id=(value) -> ::Integer
Parameter
  • value (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.
Returns
  • (::Integer) — Output only. [Output Only] The unique identifier for the resource. This identifier is defined by the server.

#kind

def kind() -> ::String
Returns
  • (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.

#kind=

def kind=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.
Returns
  • (::String) — Output only. [Output Only] Type of the resource. Alwayscompute#reservations for reservations.

#linked_commitments

def linked_commitments() -> ::Array<::String>
Returns
  • (::Array<::String>) — Output only. [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.

#linked_commitments=

def linked_commitments=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — Output only. [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.
Returns
  • (::Array<::String>) — Output only. [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments.

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

#params

def params() -> ::Google::Cloud::Compute::V1::ReservationParams
Returns

#params=

def params=(value) -> ::Google::Cloud::Compute::V1::ReservationParams
Parameter
Returns

#protection_tier

def protection_tier() -> ::String
Returns
  • (::String) — Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). Check the ProtectionTier enum for the list of possible values.

#protection_tier=

def protection_tier=(value) -> ::String
Parameter
  • value (::String) — Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). Check the ProtectionTier enum for the list of possible values.
Returns
  • (::String) — Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). Check the ProtectionTier enum for the list of possible values.

#reservation_sharing_policy

def reservation_sharing_policy() -> ::Google::Cloud::Compute::V1::AllocationReservationSharingPolicy
Returns

#reservation_sharing_policy=

def reservation_sharing_policy=(value) -> ::Google::Cloud::Compute::V1::AllocationReservationSharingPolicy
Parameter
Returns

#resource_policies

def resource_policies() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#resource_policies=

def resource_policies=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — 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.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — 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.

#resource_status

def resource_status() -> ::Google::Cloud::Compute::V1::AllocationResourceStatus
Returns

#resource_status=

def resource_status=(value) -> ::Google::Cloud::Compute::V1::AllocationResourceStatus
Parameter
Returns

#satisfies_pzs

def satisfies_pzs() -> ::Boolean
Returns
  • (::Boolean) — Output only. [Output Only] Reserved for future use.

#satisfies_pzs=

def satisfies_pzs=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Output only. [Output Only] Reserved for future use.
Returns
  • (::Boolean) — Output only. [Output Only] Reserved for future use.

#scheduling_type

def scheduling_type() -> ::String
Returns
  • (::String) — The type of maintenance for the reservation. Check the SchedulingType enum for the list of possible values.

#scheduling_type=

def scheduling_type=(value) -> ::String
Parameter
  • value (::String) — The type of maintenance for the reservation. Check the SchedulingType enum for the list of possible values.
Returns
  • (::String) — The type of maintenance for the 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.

#share_settings

def share_settings() -> ::Google::Cloud::Compute::V1::ShareSettings
Returns
  • (::Google::Cloud::Compute::V1::ShareSettings) — 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.

#share_settings=

def share_settings=(value) -> ::Google::Cloud::Compute::V1::ShareSettings
Parameter
  • value (::Google::Cloud::Compute::V1::ShareSettings) — 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.
Returns
  • (::Google::Cloud::Compute::V1::ShareSettings) — 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.

#specific_reservation

def specific_reservation() -> ::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation
Returns

#specific_reservation=

def specific_reservation=(value) -> ::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation
Parameter
Returns

#specific_reservation_required

def specific_reservation_required() -> ::Boolean
Returns
  • (::Boolean) — 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.

#specific_reservation_required=

def specific_reservation_required=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#status

def status() -> ::String
Returns
  • (::String) — Output only. [Output Only] The status of the reservation.

     - CREATING: Reservation resources are being
   allocated.
 - READY: Reservation resources have been allocated,
   and the reservation is ready for use.
 - DELETING: Reservation deletion is in progress.
 - UPDATING: Reservation update is in progress.

    Check the Status enum for the list of possible values.

#status=

def status=(value) -> ::String
Parameter
  • value (::String) — Output only. [Output Only] The status of the reservation.

     - CREATING: Reservation resources are being
   allocated.
 - READY: Reservation resources have been allocated,
   and the reservation is ready for use.
 - DELETING: Reservation deletion is in progress.
 - UPDATING: Reservation update is in progress.

    Check the Status enum for the list of possible values.

Returns
  • (::String) — Output only. [Output Only] The status of the reservation.

     - CREATING: Reservation resources are being
   allocated.
 - READY: Reservation resources have been allocated,
   and the reservation is ready for use.
 - DELETING: Reservation deletion is in progress.
 - UPDATING: Reservation update is in progress.

    Check the Status enum for the list of possible values.

#zone

def zone() -> ::String
Returns
  • (::String) — Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.

#zone=

def zone=(value) -> ::String
Parameter
  • value (::String) — Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.
Returns
  • (::String) — Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment.