Class: Google::Apis::ComputeV1::Reservation

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/compute_v1/classes.rb,
lib/google/apis/compute_v1/representations.rb,
lib/google/apis/compute_v1/representations.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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Reservation

Returns a new instance of Reservation.



31219
31220
31221
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31219

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#aggregate_reservation ⇒ Google::Apis::ComputeV1::AllocationAggregateReservation

This reservation type is specified by total resource amounts (e.g. total count of CPUs) and can account for multiple instance SKUs. In other words, one can create instances of varying shapes against this reservation. Corresponds to the JSON property aggregateReservation

Returns:



31124
31125
31126
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31124

def aggregate_reservation
  @aggregate_reservation
end

#commitment ⇒ String

[Output Only] Full or partial URL to a parent commitment. This field displays for reservations that are tied to a commitment. Corresponds to the JSON property commitment

Returns:

  • (String) 


31130
31131
31132
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31130

def commitment
  @commitment
end

#creation_timestamp ⇒ String

[Output Only] Creation timestamp in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


31135
31136
31137
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31135

def creation_timestamp
  @creation_timestamp
end

#description ⇒ String

An optional description of this resource. Provide this property when you create the resource. Corresponds to the JSON property description

Returns:

  • (String) 


31141
31142
31143
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31141

def description
  @description
end

#id ⇒ Fixnum

[Output Only] The unique identifier for the resource. This identifier is defined by the server. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


31147
31148
31149
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31147

def id
  @id
end

#kind ⇒ String

[Output Only] Type of the resource. Always compute#reservations for reservations. Corresponds to the JSON property kind

Returns:

  • (String) 


31153
31154
31155
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31153

def kind
  @kind
end

#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 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. Corresponds to the JSON property name

Returns:

  • (String) 


31164
31165
31166
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31164

def name
  @name
end

#resource_policies ⇒ Hash<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. Corresponds to the JSON property resourcePolicies

Returns:

  • (Hash<String,String>) 


31171
31172
31173
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31171

def resource_policies
  @resource_policies
end

#resource_status ⇒ Google::Apis::ComputeV1::AllocationResourceStatus

[Output Only] Contains output only fields. Corresponds to the JSON property resourceStatus

Returns:



31176
31177
31178
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31176

def resource_status
  @resource_status
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

[Output Only] Reserved for future use. Corresponds to the JSON property satisfiesPzs

Returns:

  • (Boolean) 


31181
31182
31183
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31181

def satisfies_pzs
  @satisfies_pzs
end

#self_link ⇒ String

[Output Only] Server-defined fully-qualified URL for this resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


31187
31188
31189
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31187

def self_link
  @self_link
end

#share_settings ⇒ Google::Apis::ComputeV1::ShareSettings

The share setting for reservations and sole tenancy node groups. Corresponds to the JSON property shareSettings

Returns:



31192
31193
31194
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31192

def share_settings
  @share_settings
end

#specific_reservation ⇒ Google::Apis::ComputeV1::AllocationSpecificSkuReservation

This reservation type allows to pre allocate specific instance configuration. Next ID: 6 Corresponds to the JSON property specificReservation

Returns:



31198
31199
31200
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31198

def specific_reservation
  @specific_reservation
end

#specific_reservation_required ⇒ Boolean Also known as: specific_reservation_required?

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. Corresponds to the JSON property specificReservationRequired

Returns:

  • (Boolean) 


31205
31206
31207
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31205

def specific_reservation_required
  @specific_reservation_required
end

#status ⇒ String

[Output Only] The status of the reservation. Corresponds to the JSON property status

Returns:

  • (String) 


31211
31212
31213
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31211

def status
  @status
end

#zone ⇒ String

Zone in which the reservation resides. A zone must be provided if the reservation is created within a commitment. Corresponds to the JSON property zone

Returns:

  • (String) 


31217
31218
31219
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31217

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



31224
31225
31226
31227
31228
31229
31230
31231
31232
31233
31234
31235
31236
31237
31238
31239
31240
31241
 
# File 'lib/google/apis/compute_v1/classes.rb', line 31224

def update!(**args)
  @aggregate_reservation = args[:aggregate_reservation] if args.key?(:aggregate_reservation)
  @commitment = args[:commitment] if args.key?(:commitment)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @description = args[:description] if args.key?(:description)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @resource_policies = args[:resource_policies] if args.key?(:resource_policies)
  @resource_status = args[:resource_status] if args.key?(:resource_status)
  @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs)
  @self_link = args[:self_link] if args.key?(:self_link)
  @share_settings = args[:share_settings] if args.key?(:share_settings)
  @specific_reservation = args[:specific_reservation] if args.key?(:specific_reservation)
  @specific_reservation_required = args[:specific_reservation_required] if args.key?(:specific_reservation_required)
  @status = args[:status] if args.key?(:status)
  @zone = args[:zone] if args.key?(:zone)
end