Interface SchedulingOrBuilder (1.65.0)

Version latest

• 1.65.0 (latest)
• 1.64.0
• 1.63.0
• 1.62.0
• 1.61.0
• 1.59.0
• 1.58.0
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.0
• 1.53.0
• 1.52.0
• 1.51.0
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.1
• 1.11.0
• 1.9.1
• 1.8.1
• 1.7.2
• 1.6.0-beta

public interface SchedulingOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAutomaticRestart()

public abstract boolean 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.

optional bool automatic_restart = 350821371;

Returns
Type	Description
boolean	The automaticRestart.

getAvailabilityDomain()

public abstract int getAvailabilityDomain()

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
int	The availabilityDomain.

getInstanceTerminationAction()

public abstract String getInstanceTerminationAction()

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
String	The instanceTerminationAction.

getInstanceTerminationActionBytes()

public abstract ByteString getInstanceTerminationActionBytes()

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
ByteString	The bytes for instanceTerminationAction.

getLocalSsdRecoveryTimeout()

public abstract Duration 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.

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

Returns
Type	Description
Duration	The localSsdRecoveryTimeout.

getLocalSsdRecoveryTimeoutOrBuilder()

public abstract DurationOrBuilder getLocalSsdRecoveryTimeoutOrBuilder()

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
DurationOrBuilder

getLocationHint()

public abstract String 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.

optional string location_hint = 350519505;

Returns
Type	Description
String	The locationHint.

getLocationHintBytes()

public abstract ByteString getLocationHintBytes()

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
ByteString	The bytes for locationHint.

getMaxRunDuration()

public abstract Duration getMaxRunDuration()

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
Duration	The maxRunDuration.

getMaxRunDurationOrBuilder()

public abstract DurationOrBuilder getMaxRunDurationOrBuilder()

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
DurationOrBuilder

getMinNodeCpus()

public abstract int getMinNodeCpus()

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
int	The minNodeCpus.

getNodeAffinities(int index)

public abstract SchedulingNodeAffinity getNodeAffinities(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

getNodeAffinitiesCount()

public abstract int getNodeAffinitiesCount()

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
int

getNodeAffinitiesList()

public abstract List<SchedulingNodeAffinity> getNodeAffinitiesList()

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
List<SchedulingNodeAffinity>

getNodeAffinitiesOrBuilder(int index)

public abstract SchedulingNodeAffinityOrBuilder getNodeAffinitiesOrBuilder(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
SchedulingNodeAffinityOrBuilder

getNodeAffinitiesOrBuilderList()

public abstract List<? extends SchedulingNodeAffinityOrBuilder> getNodeAffinitiesOrBuilderList()

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
List<? extends com.google.cloud.compute.v1.SchedulingNodeAffinityOrBuilder>

getOnHostMaintenance()

public abstract String 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.

optional string on_host_maintenance = 64616796;

Returns
Type	Description
String	The onHostMaintenance.

getOnHostMaintenanceBytes()

public abstract ByteString getOnHostMaintenanceBytes()

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
ByteString	The bytes for onHostMaintenance.

getOnInstanceStopAction()

public abstract SchedulingOnInstanceStopAction getOnInstanceStopAction()

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

Returns
Type	Description
SchedulingOnInstanceStopAction	The onInstanceStopAction.

getOnInstanceStopActionOrBuilder()

public abstract SchedulingOnInstanceStopActionOrBuilder getOnInstanceStopActionOrBuilder()

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

Returns
Type	Description
SchedulingOnInstanceStopActionOrBuilder

getPreemptible()

public abstract boolean 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.

optional bool preemptible = 324203169;

Returns
Type	Description
boolean	The preemptible.

getProvisioningModel()

public abstract String getProvisioningModel()

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
String	The provisioningModel.

getProvisioningModelBytes()

public abstract ByteString getProvisioningModelBytes()

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
ByteString	The bytes for provisioningModel.

getTerminationTime()

public abstract String getTerminationTime()

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
String	The terminationTime.

getTerminationTimeBytes()

public abstract ByteString getTerminationTimeBytes()

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
ByteString	The bytes for terminationTime.

hasAutomaticRestart()

public abstract boolean hasAutomaticRestart()

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
boolean	Whether the automaticRestart field is set.

hasAvailabilityDomain()

public abstract boolean hasAvailabilityDomain()

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
boolean	Whether the availabilityDomain field is set.

hasInstanceTerminationAction()

public abstract boolean hasInstanceTerminationAction()

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
boolean	Whether the instanceTerminationAction field is set.

hasLocalSsdRecoveryTimeout()

public abstract boolean hasLocalSsdRecoveryTimeout()

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
boolean	Whether the localSsdRecoveryTimeout field is set.

hasLocationHint()

public abstract boolean hasLocationHint()

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
boolean	Whether the locationHint field is set.

hasMaxRunDuration()

public abstract boolean hasMaxRunDuration()

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
boolean	Whether the maxRunDuration field is set.

hasMinNodeCpus()

public abstract boolean hasMinNodeCpus()

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
boolean	Whether the minNodeCpus field is set.

hasOnHostMaintenance()

public abstract boolean hasOnHostMaintenance()

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
boolean	Whether the onHostMaintenance field is set.

hasOnInstanceStopAction()

public abstract boolean hasOnInstanceStopAction()

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

Returns
Type	Description
boolean	Whether the onInstanceStopAction field is set.

hasPreemptible()

public abstract boolean hasPreemptible()

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
boolean	Whether the preemptible field is set.

hasProvisioningModel()

public abstract boolean hasProvisioningModel()

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
boolean	Whether the provisioningModel field is set.

hasTerminationTime()

public abstract boolean hasTerminationTime()

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
boolean	Whether the terminationTime field is set.