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
#commitment
def commitment() -> ::String Returns
- (::String) — [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] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment.
Returns
- (::String) — [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] Creation timestamp in RFC3339 text format.
#creation_timestamp=
def creation_timestamp=(value) -> ::String Parameter
- value (::String) — [Output Only] Creation timestamp in RFC3339 text format.
Returns
- (::String) — [Output Only] Creation timestamp in RFC3339 text format.
#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.
#id
def id() -> ::Integer Returns
- (::Integer) — [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] The unique identifier for the resource. This identifier is defined by the server.
Returns
- (::Integer) — [Output Only] The unique identifier for the resource. This identifier is defined by the server.
#kind
def kind() -> ::String Returns
- (::String) — [Output Only] Type of the resource. Always compute#reservations for reservations.
#kind=
def kind=(value) -> ::String Parameter
- value (::String) — [Output Only] Type of the resource. Always compute#reservations for reservations.
Returns
- (::String) — [Output Only] Type of the resource. Always compute#reservations for 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 with RFC1035. 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 with RFC1035. 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 with RFC1035. 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.
#satisfies_pzs
def satisfies_pzs() -> ::Boolean Returns
- (::Boolean) — [Output Only] Reserved for future use.
#satisfies_pzs=
def satisfies_pzs=(value) -> ::Boolean Parameter
- value (::Boolean) — [Output Only] Reserved for future use.
Returns
- (::Boolean) — [Output Only] Reserved for future use.
#self_link
def self_link() -> ::String Returns
- (::String) — [Output Only] Server-defined fully-qualified URL for this resource.
#self_link=
def self_link=(value) -> ::String Parameter
- value (::String) — [Output Only] Server-defined fully-qualified URL for this resource.
Returns
- (::String) — [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) — Share-settings for shared-reservation
#share_settings=
def share_settings=(value) -> ::Google::Cloud::Compute::V1::ShareSettings Parameter
- value (::Google::Cloud::Compute::V1::ShareSettings) — Share-settings for shared-reservation
Returns
- (::Google::Cloud::Compute::V1::ShareSettings) — Share-settings for shared-reservation
#specific_reservation
def specific_reservation() -> ::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation Returns
- (::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation) — Reservation for instances with specific machine shapes.
#specific_reservation=
def specific_reservation=(value) -> ::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation Parameter
- value (::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation) — Reservation for instances with specific machine shapes.
Returns
- (::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation) — Reservation for instances with specific machine shapes.
#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] The status of the reservation. Check the Status enum for the list of possible values.
#status=
def status=(value) -> ::String Parameter
- value (::String) — [Output Only] The status of the reservation. Check the Status enum for the list of possible values.
Returns
- (::String) — [Output Only] The status of the reservation. 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.