Class Scheduling.Builder (1.88.0)

public static final class Scheduling.Builder extends GeneratedMessageV3.Builder<Scheduling.Builder> implements SchedulingOrBuilder

Sets the scheduling options for an Instance.

Protobuf type google.cloud.compute.v1.Scheduling

Implements

SchedulingOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllNodeAffinities(Iterable<? extends SchedulingNodeAffinity> values)

public Scheduling.Builder addAllNodeAffinities(Iterable<? extends SchedulingNodeAffinity> values)

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Parameter
Name Description
values Iterable<? extends com.google.cloud.compute.v1.SchedulingNodeAffinity>
Returns
Type Description
Scheduling.Builder

addNodeAffinities(SchedulingNodeAffinity value)

public Scheduling.Builder addNodeAffinities(SchedulingNodeAffinity value)

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Parameter
Name Description
value SchedulingNodeAffinity
Returns
Type Description
Scheduling.Builder

addNodeAffinities(SchedulingNodeAffinity.Builder builderForValue)

public Scheduling.Builder addNodeAffinities(SchedulingNodeAffinity.Builder builderForValue)

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Parameter
Name Description
builderForValue SchedulingNodeAffinity.Builder
Returns
Type Description
Scheduling.Builder

addNodeAffinities(int index, SchedulingNodeAffinity value)

public Scheduling.Builder addNodeAffinities(int index, SchedulingNodeAffinity value)

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Parameters
Name Description
index int
value SchedulingNodeAffinity
Returns
Type Description
Scheduling.Builder

addNodeAffinities(int index, SchedulingNodeAffinity.Builder builderForValue)

public Scheduling.Builder addNodeAffinities(int index, SchedulingNodeAffinity.Builder builderForValue)

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Parameters
Name Description
index int
builderForValue SchedulingNodeAffinity.Builder
Returns
Type Description
Scheduling.Builder

addNodeAffinitiesBuilder()

public SchedulingNodeAffinity.Builder addNodeAffinitiesBuilder()

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Returns
Type Description
SchedulingNodeAffinity.Builder

addNodeAffinitiesBuilder(int index)

public SchedulingNodeAffinity.Builder addNodeAffinitiesBuilder(int index)

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Parameter
Name Description
index int
Returns
Type Description
SchedulingNodeAffinity.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Scheduling.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Scheduling.Builder
Overrides

build()

public Scheduling build()
Returns
Type Description
Scheduling

buildPartial()

public Scheduling buildPartial()
Returns
Type Description
Scheduling

clear()

public Scheduling.Builder clear()
Returns
Type Description
Scheduling.Builder
Overrides

clearAutomaticRestart()

public Scheduling.Builder clearAutomaticRestart()

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.

optional bool automatic_restart = 350821371;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearAvailabilityDomain()

public Scheduling.Builder clearAvailabilityDomain()

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.

optional int32 availability_domain = 252514344;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Scheduling.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Scheduling.Builder
Overrides

clearHostErrorTimeoutSeconds()

public Scheduling.Builder clearHostErrorTimeoutSeconds()

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.

optional int32 host_error_timeout_seconds = 408317459;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearInstanceTerminationAction()

public Scheduling.Builder clearInstanceTerminationAction()

Specifies the termination action for the instance. Check the InstanceTerminationAction enum for the list of possible values.

optional string instance_termination_action = 107380667;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearLocalSsdRecoveryTimeout()

public Scheduling.Builder clearLocalSsdRecoveryTimeout()

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.

optional .google.cloud.compute.v1.Duration local_ssd_recovery_timeout = 268015590;

Returns
Type Description
Scheduling.Builder

clearLocationHint()

public Scheduling.Builder clearLocationHint()

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.

optional string location_hint = 350519505;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearMaxRunDuration()

public Scheduling.Builder clearMaxRunDuration()

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.

optional .google.cloud.compute.v1.Duration max_run_duration = 430839747;

Returns
Type Description
Scheduling.Builder

clearMinNodeCpus()

public Scheduling.Builder clearMinNodeCpus()

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

optional int32 min_node_cpus = 317231675;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearNodeAffinities()

public Scheduling.Builder clearNodeAffinities()

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

repeated .google.cloud.compute.v1.SchedulingNodeAffinity node_affinities = 461799971;

Returns
Type Description
Scheduling.Builder

clearOnHostMaintenance()

public Scheduling.Builder clearOnHostMaintenance()

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.

optional string on_host_maintenance = 64616796;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearOnInstanceStopAction()

public Scheduling.Builder clearOnInstanceStopAction()

optional .google.cloud.compute.v1.SchedulingOnInstanceStopAction on_instance_stop_action = 529876681;

Returns
Type Description
Scheduling.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public Scheduling.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Scheduling.Builder
Overrides

clearPreemptible()

public Scheduling.Builder clearPreemptible()

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.

optional bool preemptible = 324203169;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearProvisioningModel()

public Scheduling.Builder clearProvisioningModel()

Specifies the provisioning model of the instance. Check the ProvisioningModel enum for the list of possible values.

optional string provisioning_model = 494423;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearSkipGuestOsShutdown()

public Scheduling.Builder clearSkipGuestOsShutdown()

Default is false and there will be 120 seconds between GCE ACPI G2 Soft Off and ACPI G3 Mechanical Off for Standard VMs and 30 seconds for Spot VMs.

optional bool skip_guest_os_shutdown = 201662378;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clearTerminationTime()

public Scheduling.Builder clearTerminationTime()

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.

optional string termination_time = 428082984;

Returns
Type Description
Scheduling.Builder

This builder for chaining.

clone()

public Scheduling.Builder clone()
Returns
Type Description
Scheduling.Builder
Overrides