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.
-
#on_instance_stop_action ⇒ Google::Apis::ComputeAlpha::SchedulingOnInstanceStopAction
Defines the behaviour for instances with the instance_termination_action STOP.
-
#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.
-
#windows_license_optimization_mode ⇒ String
Represents the Windows Server License Optimization Mode of the VM.
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.
43544 43545 43546 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43544 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
43409 43410 43411 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43409 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
43419 43420 43421 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43419 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
43425 43426 43427 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43425 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
43431 43432 43433 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43431 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
43436 43437 43438 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43436 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
43443 43444 43445 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43443 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
43448 43449 43450 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43448 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
43455 43456 43457 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43455 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
43464 43465 43466 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43464 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
43470 43471 43472 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43470 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
43476 43477 43478 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43476 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
43482 43483 43484 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43482 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
43490 43491 43492 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43490 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
43496 43497 43498 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43496 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
43502 43503 43504 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43502 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
43510 43511 43512 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43510 def on_host_maintenance @on_host_maintenance end |
#on_instance_stop_action ⇒ Google::Apis::ComputeAlpha::SchedulingOnInstanceStopAction
Defines the behaviour for instances with the instance_termination_action STOP.
Corresponds to the JSON property onInstanceStopAction
43515 43516 43517 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43515 def on_instance_stop_action @on_instance_stop_action 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
43523 43524 43525 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43523 def preemptible @preemptible end |
#provisioning_model ⇒ String
Specifies the provisioning model of the instance.
Corresponds to the JSON property provisioningModel
43529 43530 43531 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43529 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
43536 43537 43538 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43536 def termination_time @termination_time end |
#windows_license_optimization_mode ⇒ String
Represents the Windows Server License Optimization Mode of the VM. If
unspecified, the default mode is OFF.
Corresponds to the JSON property windowsLicenseOptimizationMode
43542 43543 43544 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43542 def windows_license_optimization_mode @windows_license_optimization_mode end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
43549 43550 43551 43552 43553 43554 43555 43556 43557 43558 43559 43560 43561 43562 43563 43564 43565 43566 43567 43568 43569 43570 43571 |
# File 'lib/google/apis/compute_alpha/classes.rb', line 43549 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) @on_instance_stop_action = args[:on_instance_stop_action] if args.key?(:on_instance_stop_action) @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) @windows_license_optimization_mode = args[:windows_license_optimization_mode] if args.key?(:windows_license_optimization_mode) end |