Compute V1 Client - Class Scheduling (1.7.1)

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

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.
`↳ 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

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`

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

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

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`