Compute V1 Client - Class Scheduling (1.14.0)

Version 1.14.0

• 1.18.0 (latest)
• 1.17.0
• 1.16.2
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.1
• 1.10.1
• 1.9.1
• 1.8.3
• 1.7.1
• 1.6.1
• 1.5.0

Reference documentation and code samples for the Compute V1 Client class Scheduling.

Sets the scheduling options for an Instance.

Generated from protobuf message google.cloud.compute.v1.Scheduling

Namespace

Google \ Cloud \ Compute \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ automatic_restart	bool 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.
↳ instance_termination_action	string Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.
↳ local_ssd_recovery_timeout	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	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.
↳ min_node_cpus	int The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.
↳ node_affinities	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	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.
↳ preemptible	bool 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	string Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

getAutomaticRestart

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
Type	Description
bool

hasAutomaticRestart

clearAutomaticRestart

setAutomaticRestart

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getInstanceTerminationAction

Specifies the termination action for the instance.

Check the InstanceTerminationAction enum for the list of possible values.

Returns
Type	Description
string

hasInstanceTerminationAction

clearInstanceTerminationAction

setInstanceTerminationAction

Specifies the termination action for the instance.

Check the InstanceTerminationAction enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getLocalSsdRecoveryTimeout

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
Type	Description
Google\Cloud\Compute\V1\Duration|null

hasLocalSsdRecoveryTimeout

clearLocalSsdRecoveryTimeout

setLocalSsdRecoveryTimeout

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.

Parameter
Name	Description
var	Google\Cloud\Compute\V1\Duration

Returns
Type	Description
$this

getLocationHint

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
Type	Description
string

hasLocationHint

clearLocationHint

setLocationHint

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getMinNodeCpus

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

Returns
Type	Description
int

hasMinNodeCpus

clearMinNodeCpus

setMinNodeCpus

The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getNodeAffinities

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setNodeAffinities

A set of node affinity and anti-affinity configurations. Refer to Configuring node affinity for more information. Overrides reservationAffinity.

Parameter
Name	Description
var	array<Google\Cloud\Compute\V1\SchedulingNodeAffinity>

Returns
Type	Description
$this

getOnHostMaintenance

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
Type	Description
string

hasOnHostMaintenance

clearOnHostMaintenance

setOnHostMaintenance

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.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getPreemptible

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
Type	Description
bool

hasPreemptible

clearPreemptible

setPreemptible

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.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getProvisioningModel

Specifies the provisioning model of the instance.

Check the ProvisioningModel enum for the list of possible values.

Returns
Type	Description
string

hasProvisioningModel

clearProvisioningModel

setProvisioningModel

Specifies the provisioning model of the instance.

Check the ProvisioningModel enum for the list of possible values.

Parameter
Name	Description
var	string

Returns
Type	Description
$this