Class: Google::Apis::ComputeAlpha::Reservation

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



60312
60313
60314
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60312

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

Instance Attribute Details

#advanced_deployment_control ⇒ Google::Apis::ComputeAlpha::ReservationAdvancedDeploymentControl

Advance control for cluster management, applicable only to DENSE deployment type reservations. Corresponds to the JSON property advancedDeploymentControl

Returns:



60117
60118
60119
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60117

def advanced_deployment_control
  @advanced_deployment_control
end

#aggregate_reservation ⇒ Google::Apis::ComputeAlpha::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:



60124
60125
60126
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60124

def aggregate_reservation
  @aggregate_reservation
end

#commitment ⇒ String

Output only. [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) 


60131
60132
60133
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60131

def commitment
  @commitment
end

#confidential_compute_type ⇒ String

Corresponds to the JSON property confidentialComputeType

Returns:

  • (String) 


60136
60137
60138
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60136

def confidential_compute_type
  @confidential_compute_type
end

#creation_timestamp ⇒ String

Output only. [Output Only] Creation timestamp inRFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


60142
60143
60144
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60142

def creation_timestamp
  @creation_timestamp
end

#delete_after_duration ⇒ Google::Apis::ComputeAlpha::Duration

A Duration represents a fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution. It is independent of any calendar and concepts like "day" or "month". Range is approximately 10,000 years. Corresponds to the JSON property deleteAfterDuration

Returns:



60150
60151
60152
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60150

def delete_after_duration
  @delete_after_duration
end

#delete_at_time ⇒ String

Absolute time in future when the reservation will be auto-deleted by Compute Engine. Timestamp is represented inRFC3339 text format. Corresponds to the JSON property deleteAtTime

Returns:

  • (String) 


60157
60158
60159
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60157

def delete_at_time
  @delete_at_time
end

#deployment_type ⇒ String

Specifies the deployment strategy for this reservation. Corresponds to the JSON property deploymentType

Returns:

  • (String) 


60162
60163
60164
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60162

def deployment_type
  @deployment_type
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) 


60168
60169
60170
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60168

def description
  @description
end

#early_access_maintenance ⇒ 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. Corresponds to the JSON property earlyAccessMaintenance

Returns:

  • (String) 


60175
60176
60177
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60175

def early_access_maintenance
  @early_access_maintenance
end

#enable_emergent_maintenance ⇒ Boolean Also known as: enable_emergent_maintenance?

Indicates whether Compute Engine allows unplanned maintenance for your VMs; for example, to fix hardware errors. Corresponds to the JSON property enableEmergentMaintenance

Returns:

  • (Boolean) 


60181
60182
60183
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60181

def enable_emergent_maintenance
  @enable_emergent_maintenance
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


60189
60190
60191
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60189

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


60195
60196
60197
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60195

def kind
  @kind
end

#linked_commitments ⇒ Array<String>

Output only. [Output Only] Full or partial URL to parent commitments. This field displays for reservations that are tied to multiple commitments. Corresponds to the JSON property linkedCommitments

Returns:

  • (Array<String>) 


60202
60203
60204
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60202

def linked_commitments
  @linked_commitments
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 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. Corresponds to the JSON property name

Returns:

  • (String) 


60214
60215
60216
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60214

def name
  @name
end

#params ⇒ Google::Apis::ComputeAlpha::ReservationParams

Additional reservation params. Corresponds to the JSON property params

Returns:



60219
60220
60221
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60219

def params
  @params
end

#protection_tier ⇒ 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). Corresponds to the JSON property protectionTier

Returns:

  • (String) 


60226
60227
60228
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60226

def protection_tier
  @protection_tier
end

#reservation_mode ⇒ String

Output only. [Output only] Indicates the reservation mode of the reservation. Corresponds to the JSON property reservationMode

Returns:

  • (String) 


60231
60232
60233
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60231

def reservation_mode
  @reservation_mode
end

#reservation_sharing_policy ⇒ Google::Apis::ComputeAlpha::AllocationReservationSharingPolicy

Specify the reservation sharing policy. If unspecified, the reservation will not be shared with Google Cloud managed services. Corresponds to the JSON property reservationSharingPolicy

Returns:



60237
60238
60239
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60237

def reservation_sharing_policy
  @reservation_sharing_policy
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>) 


60244
60245
60246
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60244

def resource_policies
  @resource_policies
end

#resource_status ⇒ Google::Apis::ComputeAlpha::AllocationResourceStatus

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

Returns:



60249
60250
60251
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60249

def resource_status
  @resource_status
end

#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?

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

Returns:

  • (Boolean) 


60254
60255
60256
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60254

def satisfies_pzs
  @satisfies_pzs
end

#scheduling_type ⇒ String

The type of maintenance for the reservation. Corresponds to the JSON property schedulingType

Returns:

  • (String) 


60260
60261
60262
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60260

def scheduling_type
  @scheduling_type
end

#self_link ⇒ String

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

Returns:

  • (String) 


60266
60267
60268
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60266

def self_link
  @self_link
end

#self_link_with_id ⇒ String

Output only. [Output Only] Server-defined URL for this resource with the resource id. Corresponds to the JSON property selfLinkWithId

Returns:

  • (String) 


60272
60273
60274
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60272

def self_link_with_id
  @self_link_with_id
end

#share_settings ⇒ Google::Apis::ComputeAlpha::ShareSettings

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

Returns:



60277
60278
60279
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60277

def share_settings
  @share_settings
end

#specific_reservation ⇒ Google::Apis::ComputeAlpha::AllocationSpecificSkuReservation

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

Returns:



60283
60284
60285
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60283

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) 


60290
60291
60292
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60290

def specific_reservation_required
  @specific_reservation_required
end

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

Returns:

  • (String) 


60304
60305
60306
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60304

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) 


60310
60311
60312
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60310

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



60317
60318
60319
60320
60321
60322
60323
60324
60325
60326
60327
60328
60329
60330
60331
60332
60333
60334
60335
60336
60337
60338
60339
60340
60341
60342
60343
60344
60345
60346
60347
60348
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 60317

def update!(**args)
  @advanced_deployment_control = args[:advanced_deployment_control] if args.key?(:advanced_deployment_control)
  @aggregate_reservation = args[:aggregate_reservation] if args.key?(:aggregate_reservation)
  @commitment = args[:commitment] if args.key?(:commitment)
  @confidential_compute_type = args[:confidential_compute_type] if args.key?(:confidential_compute_type)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @delete_after_duration = args[:delete_after_duration] if args.key?(:delete_after_duration)
  @delete_at_time = args[:delete_at_time] if args.key?(:delete_at_time)
  @deployment_type = args[:deployment_type] if args.key?(:deployment_type)
  @description = args[:description] if args.key?(:description)
  @early_access_maintenance = args[:early_access_maintenance] if args.key?(:early_access_maintenance)
  @enable_emergent_maintenance = args[:enable_emergent_maintenance] if args.key?(:enable_emergent_maintenance)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @linked_commitments = args[:linked_commitments] if args.key?(:linked_commitments)
  @name = args[:name] if args.key?(:name)
  @params = args[:params] if args.key?(:params)
  @protection_tier = args[:protection_tier] if args.key?(:protection_tier)
  @reservation_mode = args[:reservation_mode] if args.key?(:reservation_mode)
  @reservation_sharing_policy = args[:reservation_sharing_policy] if args.key?(:reservation_sharing_policy)
  @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)
  @scheduling_type = args[:scheduling_type] if args.key?(:scheduling_type)
  @self_link = args[:self_link] if args.key?(:self_link)
  @self_link_with_id = args[:self_link_with_id] if args.key?(:self_link_with_id)
  @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