Class: Google::Apis::ComputeBeta::Reservation

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



36473
36474
36475
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36473

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

Instance Attribute Details

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



36351
36352
36353
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36351

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) 


36357
36358
36359
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36357

def commitment
  @commitment
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


36362
36363
36364
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36362

def creation_timestamp
  @creation_timestamp
end

#delete_after_duration ⇒ Google::Apis::ComputeBeta::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:



36370
36371
36372
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36370

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 in RFC3339 text format. Corresponds to the JSON property deleteAtTime

Returns:

  • (String) 


36376
36377
36378
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36376

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) 


36381
36382
36383
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36381

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) 


36387
36388
36389
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36387

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) 


36393
36394
36395
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36393

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) 


36399
36400
36401
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36399

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) 


36410
36411
36412
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36410

def name
  @name
end

#reservation_sharing_policy ⇒ Google::Apis::ComputeBeta::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:



36416
36417
36418
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36416

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>) 


36423
36424
36425
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36423

def resource_policies
  @resource_policies
end

#resource_status ⇒ Google::Apis::ComputeBeta::AllocationResourceStatus

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

Returns:



36428
36429
36430
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36428

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) 


36433
36434
36435
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36433

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) 


36439
36440
36441
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36439

def self_link
  @self_link
end

#share_settings ⇒ Google::Apis::ComputeBeta::ShareSettings

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

Returns:



36444
36445
36446
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36444

def share_settings
  @share_settings
end

#specific_reservation ⇒ Google::Apis::ComputeBeta::AllocationSpecificSkuReservation

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

Returns:



36449
36450
36451
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36449

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) 


36456
36457
36458
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36456

def specific_reservation_required
  @specific_reservation_required
end

#status ⇒ String

[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) 


36465
36466
36467
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36465

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) 


36471
36472
36473
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36471

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



36478
36479
36480
36481
36482
36483
36484
36485
36486
36487
36488
36489
36490
36491
36492
36493
36494
36495
36496
36497
36498
36499
 
# File 'lib/google/apis/compute_beta/classes.rb', line 36478

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)
  @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)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @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)
  @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