Class: Google::Apis::ComputeBeta::FutureReservation

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ FutureReservation

Returns a new instance of FutureReservation.



16004
16005
16006
 
# File 'lib/google/apis/compute_beta/classes.rb', line 16004

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:



15805
15806
15807
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15805

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:



15812
15813
15814
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15812

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) 


15819
15820
15821
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15819

def auto_created_reservations_delete_time
  @auto_created_reservations_delete_time
end

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

Returns:



15827
15828
15829
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15827

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) 


15839
15840
15841
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15839

def auto_delete_auto_created_reservations
  @auto_delete_auto_created_reservations
end

#commitment_info ⇒ Google::Apis::ComputeBeta::FutureReservationCommitmentInfo

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

Returns:



15846
15847
15848
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15846

def commitment_info
  @commitment_info
end

#confidential_compute_type ⇒ String

Corresponds to the JSON property confidentialComputeType

Returns:

  • (String) 


15851
15852
15853
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15851

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) 


15858
15859
15860
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15858

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) 


15863
15864
15865
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15863

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) 


15869
15870
15871
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15869

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) 


15874
15875
15876
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15874

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) 


15882
15883
15884
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15882

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) 


15888
15889
15890
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15888

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) 


15900
15901
15902
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15900

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) 


15908
15909
15910
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15908

def name_prefix
  @name_prefix
end

#params ⇒ Google::Apis::ComputeBeta::FutureReservationParams

Additional future reservation params. Corresponds to the JSON property params

Returns:



15913
15914
15915
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15913

def params
  @params
end

#planning_status ⇒ String

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

Returns:

  • (String) 


15918
15919
15920
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15918

def planning_status
  @planning_status
end

#protection_tier ⇒ String

Protection tier for the workload. Corresponds to the JSON property protectionTier

Returns:

  • (String) 


15923
15924
15925
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15923

def protection_tier
  @protection_tier
end

#reservation_mode ⇒ String

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

Returns:

  • (String) 


15929
15930
15931
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15929

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) 


15938
15939
15940
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15938

def reservation_name
  @reservation_name
end

#resource_name ⇒ String

Name of the resource intended to be delivered. Name should conform to RFC1035. This will be the name of storage pool or Exapool for persistent disk FRs. Corresponds to the JSON property resourceName

Returns:

  • (String) 


15945
15946
15947
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15945

def resource_name
  @resource_name
end

#scheduling_type ⇒ String

Maintenance information for this reservation Corresponds to the JSON property schedulingType

Returns:

  • (String) 


15950
15951
15952
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15950

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) 


15956
15957
15958
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15956

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) 


15962
15963
15964
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15962

def self_link_with_id
  @self_link_with_id
end

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

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

Returns:



15967
15968
15969
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15967

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) 


15974
15975
15976
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15974

def specific_reservation_required
  @specific_reservation_required
end

#specific_sku_properties ⇒ Google::Apis::ComputeBeta::FutureReservationSpecificSkuProperties

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

Returns:



15981
15982
15983
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15981

def specific_sku_properties
  @specific_sku_properties
end

#status ⇒ Google::Apis::ComputeBeta::FutureReservationStatus

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

Returns:



15986
15987
15988
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15986

def status
  @status
end

#storage_pool_properties ⇒ Google::Apis::ComputeBeta::FutureReservationStoragePoolProperties

Storage pool properties for the future reservation. Corresponds to the JSON property storagePoolProperties

Returns:



15991
15992
15993
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15991

def storage_pool_properties
  @storage_pool_properties
end

#time_window ⇒ Google::Apis::ComputeBeta::FutureReservationTimeWindow

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

Returns:



15996
15997
15998
 
# File 'lib/google/apis/compute_beta/classes.rb', line 15996

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) 


16002
16003
16004
 
# File 'lib/google/apis/compute_beta/classes.rb', line 16002

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
 
# File 'lib/google/apis/compute_beta/classes.rb', line 16009

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)
  @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)
  @protection_tier = args[:protection_tier] if args.key?(:protection_tier)
  @reservation_mode = args[:reservation_mode] if args.key?(:reservation_mode)
  @reservation_name = args[:reservation_name] if args.key?(:reservation_name)
  @resource_name = args[:resource_name] if args.key?(:resource_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)
  @storage_pool_properties = args[:storage_pool_properties] if args.key?(:storage_pool_properties)
  @time_window = args[:time_window] if args.key?(:time_window)
  @zone = args[:zone] if args.key?(:zone)
end