Google Cloud Compute V1 API - Class Google::Cloud::Compute::V1::Scheduling (v2.13.0)

Version latest

• 2.13.0 (latest)
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.2
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.1
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.5.0

Reference documentation and code samples for the Google Cloud Compute V1 API class Google::Cloud::Compute::V1::Scheduling.

Sets the scheduling options for an Instance.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#automatic_restart

def automatic_restart() -> ::Boolean

Returns

• (::Boolean) — 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.

#automatic_restart=

def automatic_restart=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.

#availability_domain

def availability_domain() -> ::Integer

Returns

• (::Integer) — Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

#availability_domain=

def availability_domain=(value) -> ::Integer

Parameter

• value (::Integer) — Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

Returns

• (::Integer) — Specifies the availability domain to place the instance in. The value must be a number between 1 and the number of availability domains specified in the spread placement policy attached to the instance.

#instance_termination_action

def instance_termination_action() -> ::String

Returns

• (::String) — Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.

#instance_termination_action=

def instance_termination_action=(value) -> ::String

Parameter

• value (::String) — Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.

Returns

• (::String) — Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.

#local_ssd_recovery_timeout

def local_ssd_recovery_timeout() -> ::Google::Cloud::Compute::V1::Duration

Returns

• (::Google::Cloud::Compute::V1::Duration) — Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

#local_ssd_recovery_timeout=

def local_ssd_recovery_timeout=(value) -> ::Google::Cloud::Compute::V1::Duration

Parameter

• value (::Google::Cloud::Compute::V1::Duration) — Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

Returns

• (::Google::Cloud::Compute::V1::Duration) — Specifies the maximum amount of time a Local Ssd Vm should wait while recovery of the Local Ssd state is attempted. Its value should be in between 0 and 168 hours with hour granularity and the default value being 1 hour.

#location_hint

def location_hint() -> ::String

Returns

• (::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.

#location_hint=

def location_hint=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#max_run_duration

def max_run_duration() -> ::Google::Cloud::Compute::V1::Duration

Returns

• (::Google::Cloud::Compute::V1::Duration) — Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.

#max_run_duration=

def max_run_duration=(value) -> ::Google::Cloud::Compute::V1::Duration

Parameter

• value (::Google::Cloud::Compute::V1::Duration) — Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.

Returns

• (::Google::Cloud::Compute::V1::Duration) — Specifies the max run duration for the given instance. If specified, the instance termination action will be performed at the end of the run duration.

#min_node_cpus

def min_node_cpus() -> ::Integer

Returns

• (::Integer) — The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

#min_node_cpus=

def min_node_cpus=(value) -> ::Integer

Parameter

• value (::Integer) — The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

Returns

• (::Integer) — The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

#node_affinities

def node_affinities() -> ::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>

Returns

• (::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>) — A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

#node_affinities=

def node_affinities=(value) -> ::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>

Parameter

• value (::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>) — A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

Returns

• (::Array<::Google::Cloud::Compute::V1::SchedulingNodeAffinity>) — A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

#on_host_maintenance

def on_host_maintenance() -> ::String

Returns

• (::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. Check the OnHostMaintenance enum for the list of possible values.

#on_host_maintenance=

def on_host_maintenance=(value) -> ::String

Parameter

• value (::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. Check the OnHostMaintenance enum for the list of possible values.

Returns

• (::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. Check the OnHostMaintenance enum for the list of possible values.

#on_instance_stop_action

def on_instance_stop_action() -> ::Google::Cloud::Compute::V1::SchedulingOnInstanceStopAction

Returns

• (::Google::Cloud::Compute::V1::SchedulingOnInstanceStopAction)

#on_instance_stop_action=

def on_instance_stop_action=(value) -> ::Google::Cloud::Compute::V1::SchedulingOnInstanceStopAction

Parameter

• value (::Google::Cloud::Compute::V1::SchedulingOnInstanceStopAction)

Returns

• (::Google::Cloud::Compute::V1::SchedulingOnInstanceStopAction)

#preemptible

def preemptible() -> ::Boolean

Returns

• (::Boolean) — 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.

#preemptible=

def preemptible=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.

#provisioning_model

def provisioning_model() -> ::String

Returns

• (::String) — Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

#provisioning_model=

def provisioning_model=(value) -> ::String

Parameter

• value (::String) — Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

Returns

• (::String) — Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

#termination_time

def termination_time() -> ::String

Returns

• (::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.

#termination_time=

def termination_time=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.