Class: Google::Apis::ComputeV1::FutureReservation

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FutureReservation

Returns a new instance of FutureReservation.



14543
14544
14545
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14543

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:



14368
14369
14370
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14368

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) 


14375
14376
14377
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14375

def auto_created_reservations_delete_time
  @auto_created_reservations_delete_time
end

#auto_created_reservations_duration ⇒ Google::Apis::ComputeV1::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:



14383
14384
14385
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14383

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) 


14395
14396
14397
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14395

def auto_delete_auto_created_reservations
  @auto_delete_auto_created_reservations
end

#commitment_info ⇒ Google::Apis::ComputeV1::FutureReservationCommitmentInfo

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

Returns:



14402
14403
14404
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14402

def commitment_info
  @commitment_info
end

#confidential_compute_type ⇒ String

Corresponds to the JSON property confidentialComputeType

Returns:

  • (String) 


14407
14408
14409
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14407

def confidential_compute_type
  @confidential_compute_type
end

#creation_timestamp ⇒ String

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

Returns:

  • (String) 


14414
14415
14416
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14414

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) 


14419
14420
14421
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14419

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) 


14425
14426
14427
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14425

def description
  @description
end

#enable_emergent_maintenance ⇒ Boolean Also known as: enable_emergent_maintenance?

Indicates if this group of VMs have emergent maintenance enabled. Corresponds to the JSON property enableEmergentMaintenance

Returns:

  • (Boolean) 


14430
14431
14432
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14430

def enable_emergent_maintenance
  @enable_emergent_maintenance
end

#id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


14438
14439
14440
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14438

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


14444
14445
14446
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14444

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


14456
14457
14458
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14456

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) 


14464
14465
14466
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14464

def name_prefix
  @name_prefix
end

#params ⇒ Google::Apis::ComputeV1::FutureReservationParams

Additional future reservation params. Corresponds to the JSON property params

Returns:



14469
14470
14471
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14469

def params
  @params
end

#planning_status ⇒ String

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

Returns:

  • (String) 


14474
14475
14476
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14474

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) 


14480
14481
14482
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14480

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) 


14489
14490
14491
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14489

def reservation_name
  @reservation_name
end

#scheduling_type ⇒ String

Maintenance information for this reservation Corresponds to the JSON property schedulingType

Returns:

  • (String) 


14494
14495
14496
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14494

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) 


14500
14501
14502
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14500

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) 


14506
14507
14508
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14506

def self_link_with_id
  @self_link_with_id
end

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

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

Returns:



14511
14512
14513
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14511

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) 


14518
14519
14520
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14518

def specific_reservation_required
  @specific_reservation_required
end

#specific_sku_properties ⇒ Google::Apis::ComputeV1::FutureReservationSpecificSkuProperties

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

Returns:



14525
14526
14527
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14525

def specific_sku_properties
  @specific_sku_properties
end

#status ⇒ Google::Apis::ComputeV1::FutureReservationStatus

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

Returns:



14530
14531
14532
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14530

def status
  @status
end

#time_window ⇒ Google::Apis::ComputeV1::FutureReservationTimeWindow

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

Returns:



14535
14536
14537
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14535

def time_window
  @time_window
end

#zone ⇒ String

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

Returns:

  • (String) 


14541
14542
14543
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14541

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
 
# File 'lib/google/apis/compute_v1/classes.rb', line 14548

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