Class: Google::Apis::ComputeAlpha::FutureReservation

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FutureReservation

Returns a new instance of FutureReservation.



12342
12343
12344
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12342

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

Instance Attribute Details

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



12192
12193
12194
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12192

def aggregate_reservation
  @aggregate_reservation
end

#auto_created_reservations_delete_time ⇒ String

Future timestamp when the FR auto-created reservations will be deleted by Compute Engine. Format of this field must be a valid href="https://www.ietf. org/rfc/rfc3339.txt">RFC3339 value. Corresponds to the JSON property autoCreatedReservationsDeleteTime

Returns:

  • (String) 


12199
12200
12201
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12199

def auto_created_reservations_delete_time
  @auto_created_reservations_delete_time
end

#auto_created_reservations_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 autoCreatedReservationsDuration

Returns:



12207
12208
12209
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12207

def auto_created_reservations_duration
  @auto_created_reservations_duration
end

#auto_delete_auto_created_reservations ⇒ Boolean Also known as: auto_delete_auto_created_reservations?

Setting for enabling or disabling automatic deletion for auto-created reservation. If set to true, auto-created reservations will be deleted at Future Reservation's end time (default) or at user's defined timestamp if any of the [auto_created_reservations_delete_time, auto_created_reservations_duration] values is specified. For keeping auto- created reservation indefinitely, this value should be set to false. Corresponds to the JSON property autoDeleteAutoCreatedReservations

Returns:

  • (Boolean) 


12217
12218
12219
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12217

def auto_delete_auto_created_reservations
  @auto_delete_auto_created_reservations
end

#commitment_info ⇒ Google::Apis::ComputeAlpha::FutureReservationCommitmentInfo

If not present, then FR will not deliver a new commitment or update an existing commitment. Corresponds to the JSON property commitmentInfo

Returns:



12224
12225
12226
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12224

def commitment_info
  @commitment_info
end

#creation_timestamp ⇒ String

[Output Only] The creation timestamp for this future reservation in RFC3339 text format. Corresponds to the JSON property creationTimestamp

Returns:

  • (String) 


12230
12231
12232
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12230

def creation_timestamp
  @creation_timestamp
end

#deployment_type ⇒ String

Type of the deployment requested as part of future reservation. Corresponds to the JSON property deploymentType

Returns:

  • (String) 


12235
12236
12237
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12235

def deployment_type
  @deployment_type
end

#description ⇒ String

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

Returns:

  • (String) 


12241
12242
12243
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12241

def description
  @description
end

#id ⇒ Fixnum

[Output Only] A unique identifier for this future reservation. The server defines this identifier. Corresponds to the JSON property id

Returns:

  • (Fixnum) 


12247
12248
12249
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12247

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


12253
12254
12255
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12253

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) 


12264
12265
12266
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12264

def name
  @name
end

#name_prefix ⇒ String

Name prefix for the reservations to be created at the time of delivery. The name prefix must comply with RFC1035. Maximum allowed length for name prefix is 20. Automatically created reservations name format will be -date-####. Corresponds to the JSON property namePrefix

Returns:

  • (String) 


12271
12272
12273
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12271

def name_prefix
  @name_prefix
end

#planning_status ⇒ String

Planning state before being submitted for evaluation Corresponds to the JSON property planningStatus

Returns:

  • (String) 


12276
12277
12278
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12276

def planning_status
  @planning_status
end

#reservation_mode ⇒ String

The reservation mode which determines reservation-termination behavior and expected pricing. Corresponds to the JSON property reservationMode

Returns:

  • (String) 


12282
12283
12284
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12282

def reservation_mode
  @reservation_mode
end

#reservation_name ⇒ String

Name of reservations where the capacity is provisioned at the time of delivery of future reservations. If the reservation with the given name does not exist already, it is created automatically at the time of Approval with INACTIVE state till specified start-time. Either provide the reservation_name or a name_prefix. Corresponds to the JSON property reservationName

Returns:

  • (String) 


12291
12292
12293
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12291

def reservation_name
  @reservation_name
end

#scheduling_type ⇒ String

Maintenance information for this reservation Corresponds to the JSON property schedulingType

Returns:

  • (String) 


12296
12297
12298
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12296

def scheduling_type
  @scheduling_type
end

#self_link ⇒ String

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

Returns:

  • (String) 


12301
12302
12303
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12301

def self_link
  @self_link
end

#self_link_with_id ⇒ String

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

Returns:

  • (String) 


12306
12307
12308
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12306

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:



12311
12312
12313
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12311

def share_settings
  @share_settings
end

#specific_reservation_required ⇒ Boolean Also known as: specific_reservation_required?

Indicates whether the auto-created 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 the delivered reservation. Corresponds to the JSON property specificReservationRequired

Returns:

  • (Boolean) 


12318
12319
12320
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12318

def specific_reservation_required
  @specific_reservation_required
end

#specific_sku_properties ⇒ Google::Apis::ComputeAlpha::FutureReservationSpecificSkuProperties

Future Reservation configuration to indicate instance properties and total count. Corresponds to the JSON property specificSkuProperties

Returns:



12325
12326
12327
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12325

def specific_sku_properties
  @specific_sku_properties
end

#status ⇒ Google::Apis::ComputeAlpha::FutureReservationStatus

[Output only] Represents status related to the future reservation. Corresponds to the JSON property status

Returns:



12330
12331
12332
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12330

def status
  @status
end

#time_window ⇒ Google::Apis::ComputeAlpha::FutureReservationTimeWindow

Time window for this Future Reservation. Corresponds to the JSON property timeWindow

Returns:



12335
12336
12337
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12335

def time_window
  @time_window
end

#zone ⇒ String

[Output Only] URL of the Zone where this future reservation resides. Corresponds to the JSON property zone

Returns:

  • (String) 


12340
12341
12342
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12340

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 12347

def update!(**args)
  @aggregate_reservation = args[:aggregate_reservation] if args.key?(:aggregate_reservation)
  @auto_created_reservations_delete_time = args[:auto_created_reservations_delete_time] if args.key?(:auto_created_reservations_delete_time)
  @auto_created_reservations_duration = args[:auto_created_reservations_duration] if args.key?(:auto_created_reservations_duration)
  @auto_delete_auto_created_reservations = args[:auto_delete_auto_created_reservations] if args.key?(:auto_delete_auto_created_reservations)
  @commitment_info = args[:commitment_info] if args.key?(:commitment_info)
  @creation_timestamp = args[:creation_timestamp] if args.key?(:creation_timestamp)
  @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)
  @name_prefix = args[:name_prefix] if args.key?(:name_prefix)
  @planning_status = args[:planning_status] if args.key?(:planning_status)
  @reservation_mode = args[:reservation_mode] if args.key?(:reservation_mode)
  @reservation_name = args[:reservation_name] if args.key?(:reservation_name)
  @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_required = args[:specific_reservation_required] if args.key?(:specific_reservation_required)
  @specific_sku_properties = args[:specific_sku_properties] if args.key?(:specific_sku_properties)
  @status = args[:status] if args.key?(:status)
  @time_window = args[:time_window] if args.key?(:time_window)
  @zone = args[:zone] if args.key?(:zone)
end