Class: Google::Apis::ComputeAlpha::Scheduling

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

Overview

Sets the scheduling options for an Instance.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Scheduling

Returns a new instance of Scheduling.



42304
42305
42306
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42304

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

Instance Attribute Details

#automatic_restart ⇒ Boolean Also known as: automatic_restart?

Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user). You can only set the automatic restart option for standard instances. Preemptible instances cannot be automatically restarted. By default, this is set to true so an instance is automatically restarted if it is terminated by Compute Engine. Corresponds to the JSON property automaticRestart

Returns:

  • (Boolean) 


42180
42181
42182
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42180

def automatic_restart
  @automatic_restart
end

#availability_domain ⇒ Fixnum

Specifies the availability domain (AD), which this instance should be scheduled on. The AD belongs to the spread GroupPlacementPolicy resource policy that has been assigned to the instance. Specify a value between 1-max count of availability domains in your GroupPlacementPolicy. See go/placement- policy-extension for more details. Corresponds to the JSON property availabilityDomain

Returns:

  • (Fixnum) 


42190
42191
42192
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42190

def availability_domain
  @availability_domain
end

#current_cpus ⇒ Fixnum

Current number of vCPUs available for VM. 0 or unset means default vCPUs of the current machine type. Corresponds to the JSON property currentCpus

Returns:

  • (Fixnum) 


42196
42197
42198
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42196

def current_cpus
  @current_cpus
end

#current_memory_mb ⇒ Fixnum

Current amount of memory (in MB) available for VM. 0 or unset means default amount of memory of the current machine type. Corresponds to the JSON property currentMemoryMb

Returns:

  • (Fixnum) 


42202
42203
42204
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42202

def current_memory_mb
  @current_memory_mb
end

#graceful_shutdown ⇒ Google::Apis::ComputeAlpha::SchedulingGracefulShutdown

Configuration for gracefully shutting down the instance. Corresponds to the JSON property gracefulShutdown

Returns:



42207
42208
42209
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42207

def graceful_shutdown
  @graceful_shutdown
end

#host_error_timeout_seconds ⇒ Fixnum

Specify the time in seconds for host error detection, the value must be within the range of [90, 330] with the increment of 30, if unset, the default behavior of host error recovery will be used. Corresponds to the JSON property hostErrorTimeoutSeconds

Returns:

  • (Fixnum) 


42214
42215
42216
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42214

def host_error_timeout_seconds
  @host_error_timeout_seconds
end

#instance_termination_action ⇒ String

Specifies the termination action for the instance. Corresponds to the JSON property instanceTerminationAction

Returns:

  • (String) 


42219
42220
42221
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42219

def instance_termination_action
  @instance_termination_action
end

#latency_tolerant ⇒ Boolean Also known as: latency_tolerant?

Defines whether the instance is tolerant of higher cpu latency. This can only be set during instance creation, or when the instance is not currently running. It must not be set if the preemptible option is also set. Corresponds to the JSON property latencyTolerant

Returns:

  • (Boolean) 


42226
42227
42228
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42226

def latency_tolerant
  @latency_tolerant
end

#local_ssd_recovery_timeout ⇒ 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 localSsdRecoveryTimeout

Returns:



42235
42236
42237
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42235

def local_ssd_recovery_timeout
  @local_ssd_recovery_timeout
end

#location_hint ⇒ String

An opaque location hint used to place the instance close to other resources. This field is for use by internal tools that use the public API. Corresponds to the JSON property locationHint

Returns:

  • (String) 


42241
42242
42243
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42241

def location_hint
  @location_hint
end

#maintenance_freeze_duration_hours ⇒ Fixnum

Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance. Corresponds to the JSON property maintenanceFreezeDurationHours

Returns:

  • (Fixnum) 


42247
42248
42249
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42247

def maintenance_freeze_duration_hours
  @maintenance_freeze_duration_hours
end

#maintenance_interval ⇒ String

Specifies the frequency of planned maintenance events. The accepted values are: PERIODIC. Corresponds to the JSON property maintenanceInterval

Returns:

  • (String) 


42253
42254
42255
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42253

def maintenance_interval
  @maintenance_interval
end

#max_run_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 maxRunDuration

Returns:



42261
42262
42263
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42261

def max_run_duration
  @max_run_duration
end

#min_node_cpus ⇒ Fixnum

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. Corresponds to the JSON property minNodeCpus

Returns:

  • (Fixnum) 


42267
42268
42269
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42267

def min_node_cpus
  @min_node_cpus
end

#node_affinities ⇒ Array<Google::Apis::ComputeAlpha::SchedulingNodeAffinity>

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity. Corresponds to the JSON property nodeAffinities

Returns:



42273
42274
42275
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42273

def node_affinities
  @node_affinities
end

#on_host_maintenance ⇒ String

Defines the maintenance behavior for this instance. For standard instances, the default behavior is MIGRATE. For preemptible instances, the default and only possible behavior is TERMINATE. For more information, see Set VM host maintenance policy. Corresponds to the JSON property onHostMaintenance

Returns:

  • (String) 


42281
42282
42283
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42281

def on_host_maintenance
  @on_host_maintenance
end

#preemptible ⇒ Boolean Also known as: preemptible?

Defines whether the instance is preemptible. This can only be set during instance creation or while the instance is stopped and therefore, in a TERMINATED state. See Instance Life Cycle for more information on the possible instance states. Corresponds to the JSON property preemptible

Returns:

  • (Boolean) 


42289
42290
42291
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42289

def preemptible
  @preemptible
end

#provisioning_model ⇒ String

Specifies the provisioning model of the instance. Corresponds to the JSON property provisioningModel

Returns:

  • (String) 


42295
42296
42297
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42295

def provisioning_model
  @provisioning_model
end

#termination_time ⇒ String

Specifies the timestamp, when the instance will be terminated, in RFC3339 text format. If specified, the instance termination action will be performed at the termination time. Corresponds to the JSON property terminationTime

Returns:

  • (String) 


42302
42303
42304
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42302

def termination_time
  @termination_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



42309
42310
42311
42312
42313
42314
42315
42316
42317
42318
42319
42320
42321
42322
42323
42324
42325
42326
42327
42328
42329
 
# File 'lib/google/apis/compute_alpha/classes.rb', line 42309

def update!(**args)
  @automatic_restart = args[:automatic_restart] if args.key?(:automatic_restart)
  @availability_domain = args[:availability_domain] if args.key?(:availability_domain)
  @current_cpus = args[:current_cpus] if args.key?(:current_cpus)
  @current_memory_mb = args[:current_memory_mb] if args.key?(:current_memory_mb)
  @graceful_shutdown = args[:graceful_shutdown] if args.key?(:graceful_shutdown)
  @host_error_timeout_seconds = args[:host_error_timeout_seconds] if args.key?(:host_error_timeout_seconds)
  @instance_termination_action = args[:instance_termination_action] if args.key?(:instance_termination_action)
  @latency_tolerant = args[:latency_tolerant] if args.key?(:latency_tolerant)
  @local_ssd_recovery_timeout = args[:local_ssd_recovery_timeout] if args.key?(:local_ssd_recovery_timeout)
  @location_hint = args[:location_hint] if args.key?(:location_hint)
  @maintenance_freeze_duration_hours = args[:maintenance_freeze_duration_hours] if args.key?(:maintenance_freeze_duration_hours)
  @maintenance_interval = args[:maintenance_interval] if args.key?(:maintenance_interval)
  @max_run_duration = args[:max_run_duration] if args.key?(:max_run_duration)
  @min_node_cpus = args[:min_node_cpus] if args.key?(:min_node_cpus)
  @node_affinities = args[:node_affinities] if args.key?(:node_affinities)
  @on_host_maintenance = args[:on_host_maintenance] if args.key?(:on_host_maintenance)
  @preemptible = args[:preemptible] if args.key?(:preemptible)
  @provisioning_model = args[:provisioning_model] if args.key?(:provisioning_model)
  @termination_time = args[:termination_time] if args.key?(:termination_time)
end