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.



51115
51116
51117
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51115

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

Instance Attribute Details

#advanced_deployment_control ⇒ Google::Apis::ComputeBeta::ReservationAdvancedDeploymentControl

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

Returns:



50926
50927
50928
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50926

def advanced_deployment_control
  @advanced_deployment_control
end

#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:



50933
50934
50935
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50933

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) 


50940
50941
50942
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50940

def commitment
  @commitment
end

#confidential_compute_type ⇒ String

Corresponds to the JSON property confidentialComputeType

Returns:

  • (String) 


50945
50946
50947
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50945

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) 


50951
50952
50953
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50951

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:



50959
50960
50961
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50959

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) 


50966
50967
50968
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50966

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) 


50971
50972
50973
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50971

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) 


50977
50978
50979
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50977

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) 


50984
50985
50986
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50984

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) 


50990
50991
50992
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50990

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) 


50998
50999
51000
 
# File 'lib/google/apis/compute_beta/classes.rb', line 50998

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) 


51004
51005
51006
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51004

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


51011
51012
51013
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51011

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) 


51023
51024
51025
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51023

def name
  @name
end

#params ⇒ Google::Apis::ComputeBeta::ReservationParams

Additional reservation params. Corresponds to the JSON property params

Returns:



51028
51029
51030
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51028

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) 


51035
51036
51037
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51035

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) 


51040
51041
51042
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51040

def reservation_mode
  @reservation_mode
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:



51046
51047
51048
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51046

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


51053
51054
51055
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51053

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:



51058
51059
51060
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51058

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) 


51063
51064
51065
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51063

def satisfies_pzs
  @satisfies_pzs
end

#scheduling_type ⇒ String

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

Returns:

  • (String) 


51069
51070
51071
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51069

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) 


51075
51076
51077
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51075

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:



51080
51081
51082
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51080

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:



51086
51087
51088
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51086

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) 


51093
51094
51095
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51093

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) 


51107
51108
51109
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51107

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) 


51113
51114
51115
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51113

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



51120
51121
51122
51123
51124
51125
51126
51127
51128
51129
51130
51131
51132
51133
51134
51135
51136
51137
51138
51139
51140
51141
51142
51143
51144
51145
51146
51147
51148
51149
51150
 
# File 'lib/google/apis/compute_beta/classes.rb', line 51120

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