Class: Google::Cloud::Compute::V1::Reservation

Inherits:

Object

Object
Google::Cloud::Compute::V1::Reservation

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/compute/v1/compute.rb

Overview

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.

Defined Under Namespace

Modules: Status Classes: ResourcePoliciesEntry

Instance Attribute Summary collapse

#commitment ⇒ ::String
[Output Only] Full or partial URL to a parent commitment.
#creation_timestamp ⇒ ::String
[Output Only] Creation timestamp in RFC3339 text format.
#description ⇒ ::String
An optional description of this resource.
#id ⇒ ::Integer
[Output Only] The unique identifier for the resource.
#kind ⇒ ::String
[Output Only] Type of the resource.
#name ⇒ ::String
The name of the resource, provided by the client when initially creating the resource.
#resource_policies ⇒ ::Google::Protobuf::Map{::String => ::String}
Resource policies to be added to this reservation.
#resource_status ⇒ ::Google::Cloud::Compute::V1::AllocationResourceStatus
[Output Only] Status information for Reservation resource.
#satisfies_pzs ⇒ ::Boolean
[Output Only] Reserved for future use.
#self_link ⇒ ::String
[Output Only] Server-defined fully-qualified URL for this resource.
#share_settings ⇒ ::Google::Cloud::Compute::V1::ShareSettings
Specify share-settings to create a shared reservation.
#specific_reservation ⇒ ::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation
Reservation for instances with specific machine shapes.
#specific_reservation_required ⇒ ::Boolean
Indicates whether the reservation can be consumed by VMs with affinity for "any" reservation.
#status ⇒ ::String
[Output Only] The status of the reservation.
#zone ⇒ ::String
Zone in which the reservation resides.

Instance Attribute Details

#commitment ⇒ `::String`

Returns [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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#creation_timestamp ⇒ `::String`

Returns [Output Only] Creation timestamp in RFC3339 text format.

Returns:

(::String) —
[Output Only] Creation timestamp in RFC3339 text format.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#description ⇒ `::String`

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

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#id ⇒ `::Integer`

Returns [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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#kind ⇒ `::String`

Returns [Output Only] Type of the resource. Always compute#reservations for reservations.

Returns:

(::String) —
[Output Only] Type of the resource. Always compute#reservations for reservations.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#name ⇒ `::String`

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

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#resource_policies ⇒ `::Google::Protobuf::Map{::String => ::String}`

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

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#resource_status ⇒ `::Google::Cloud::Compute::V1::AllocationResourceStatus`

Returns [Output Only] Status information for Reservation resource.

Returns:

(::Google::Cloud::Compute::V1::AllocationResourceStatus) —
[Output Only] Status information for Reservation resource.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#satisfies_pzs ⇒ `::Boolean`

Returns [Output Only] Reserved for future use.

Returns:

(::Boolean) —
[Output Only] Reserved for future use.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#self_link ⇒ `::String`

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

Returns:

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

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#share_settings ⇒ `::Google::Cloud::Compute::V1::ShareSettings`

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

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#specific_reservation ⇒ `::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation`

Returns Reservation for instances with specific machine shapes.

Returns:

(::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation) —
Reservation for instances with specific machine shapes.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#specific_reservation_required ⇒ `::Boolean`

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

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#status ⇒ `::String`

Returns [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.

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

#zone ⇒ `::String`

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

# File 'proto_docs/google/cloud/compute/v1/compute.rb', line 23048

class Reservation
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ResourcePoliciesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # [Output Only] The status of the reservation.
  module Status
    # A value indicating that the enum field is not set.
    UNDEFINED_STATUS = 0

    # Resources are being allocated for the reservation.
    CREATING = 455_564_985

    # Reservation is currently being deleted.
    DELETING = 528_602_024

    INVALID = 530_283_991

    # Reservation has allocated all its resources.
    READY = 77_848_963

    # Reservation is currently being resized.
    UPDATING = 494_614_342
  end
end

Class: Google::Cloud::Compute::V1::Reservation

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#commitment ⇒ ::String

#creation_timestamp ⇒ ::String

#description ⇒ ::String

#id ⇒ ::Integer

#kind ⇒ ::String

#name ⇒ ::String

#resource_policies ⇒ ::Google::Protobuf::Map{::String => ::String}

#resource_status ⇒ ::Google::Cloud::Compute::V1::AllocationResourceStatus

#satisfies_pzs ⇒ ::Boolean

#self_link ⇒ ::String

#share_settings ⇒ ::Google::Cloud::Compute::V1::ShareSettings

#specific_reservation ⇒ ::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation

#specific_reservation_required ⇒ ::Boolean

#status ⇒ ::String

#zone ⇒ ::String

#commitment ⇒ `::String`

#creation_timestamp ⇒ `::String`

#description ⇒ `::String`

#id ⇒ `::Integer`

#kind ⇒ `::String`

#name ⇒ `::String`

#resource_policies ⇒ `::Google::Protobuf::Map{::String => ::String}`

#resource_status ⇒ `::Google::Cloud::Compute::V1::AllocationResourceStatus`

#satisfies_pzs ⇒ `::Boolean`

#self_link ⇒ `::String`

#share_settings ⇒ `::Google::Cloud::Compute::V1::ShareSettings`

#specific_reservation ⇒ `::Google::Cloud::Compute::V1::AllocationSpecificSKUReservation`

#specific_reservation_required ⇒ `::Boolean`

#status ⇒ `::String`

#zone ⇒ `::String`