Class: Google::Apis::ComputeAlpha::Scheduling
- Inherits:
-
Object
- Object
- Google::Apis::ComputeAlpha::Scheduling
- 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
-
#automatic_restart ⇒ Boolean
(also: #automatic_restart?)
Specifies whether the instance should be automatically restarted if it is terminated by Compute Engine (not terminated by a user).
-
#availability_domain ⇒ Fixnum
Specifies the availability domain (AD), which this instance should be scheduled on.
-
#current_cpus ⇒ Fixnum
Current number of vCPUs available for VM.
-
#current_memory_mb ⇒ Fixnum
Current amount of memory (in MB) available for VM.
-
#graceful_shutdown ⇒ Google::Apis::ComputeAlpha::SchedulingGracefulShutdown
Configuration for gracefully shutting down the instance.
-
#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.
-
#instance_termination_action ⇒ String
Specifies the termination action for the instance.
-
#latency_tolerant ⇒ Boolean
(also: #latency_tolerant?)
Defines whether the instance is tolerant of higher cpu latency.
-
#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.
-
#location_hint ⇒ String
An opaque location hint used to place the instance close to other resources.
-
#maintenance_freeze_duration_hours ⇒ Fixnum
Specifies the number of hours after VM instance creation where the VM won't be scheduled for maintenance.
-
#maintenance_interval ⇒ String
Specifies the frequency of planned maintenance events.
-
#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.
-
#min_node_cpus ⇒ Fixnum
The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
-
#node_affinities ⇒ Array<Google::Apis::ComputeAlpha::SchedulingNodeAffinity>
A set of node affinity and anti-affinity configurations.
-
#on_host_maintenance ⇒ String
Defines the maintenance behavior for this instance.
-
#preemptible ⇒ Boolean
(also: #preemptible?)
Defines whether the instance is preemptible.
-
#provisioning_model ⇒ String
Specifies the provisioning model of the instance.
-
#termination_time ⇒ String
Specifies the timestamp, when the instance will be terminated, in RFC3339 text format.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Scheduling
constructor
A new instance of Scheduling.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Scheduling
Returns a new instance of Scheduling.
42390 42391 42392 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42390 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
42266 42267 42268 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42266 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
42276 42277 42278 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42276 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
42282 42283 42284 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42282 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
42288 42289 42290 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42288 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
42293 42294 42295 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42293 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
42300 42301 42302 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42300 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
42305 42306 42307 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42305 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
42312 42313 42314 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42312 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
42321 42322 42323 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42321 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
42327 42328 42329 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42327 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
42333 42334 42335 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42333 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
42339 42340 42341 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42339 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
42347 42348 42349 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42347 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
42353 42354 42355 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42353 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
42359 42360 42361 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42359 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
42367 42368 42369 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42367 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
42375 42376 42377 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42375 def preemptible @preemptible end |
#provisioning_model ⇒ String
Specifies the provisioning model of the instance.
Corresponds to the JSON property provisioningModel
42381 42382 42383 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42381 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
42388 42389 42390 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42388 def termination_time @termination_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
42395 42396 42397 42398 42399 42400 42401 42402 42403 42404 42405 42406 42407 42408 42409 42410 42411 42412 42413 42414 42415 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 42395 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 |