Share via


BatchNodeState Class

public final class BatchNodeState
extends ExpandableStringEnum<BatchNodeState>

BatchNodeState enums.

Field Summary

Modifier and Type Field and Description
static final BatchNodeState CREATING

The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool.

static final BatchNodeState DEALLOCATED

The Compute Node is deallocated.

static final BatchNodeState DEALLOCATING

The Compute Node is deallocating.

static final BatchNodeState IDLE

The Compute Node is not currently running a Task.

static final BatchNodeState LEAVING_POOL

The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down.

static final BatchNodeState OFFLINE

The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled.

static final BatchNodeState PREEMPTED

The Spot/Low-priority Compute Node has been preempted.

static final BatchNodeState REBOOTING

The Compute Node is rebooting.

static final BatchNodeState REIMAGING

The Compute Node is reimaging.

static final BatchNodeState RUNNING

The Compute Node is running one or more Tasks (other than a StartTask).

static final BatchNodeState STARTING

The Batch service is starting on the underlying virtual machine.

static final BatchNodeState START_TASK_FAILED

The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set.

static final BatchNodeState UNKNOWN

The Batch service has lost contact with the Compute Node, and does not know its true state.

static final BatchNodeState UNUSABLE

The Compute Node cannot be used for Task execution due to errors.

static final BatchNodeState UPGRADING_OS

The Compute Node is undergoing an OS upgrade operation.

static final BatchNodeState WAITING_FOR_START_TASK

The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed.

Constructor Summary

Constructor Description
BatchNodeState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchNodeState value.

Method Summary

Modifier and Type Method and Description
static BatchNodeState fromString(String name)

Creates or finds a BatchNodeState from its string representation.

static Collection<BatchNodeState> values()

Gets known BatchNodeState values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

CREATING

public static final BatchNodeState CREATING

The Batch service has obtained the underlying virtual machine from Azure Compute, but it has not yet started to join the Pool.

DEALLOCATED

public static final BatchNodeState DEALLOCATED

The Compute Node is deallocated.

DEALLOCATING

public static final BatchNodeState DEALLOCATING

The Compute Node is deallocating.

IDLE

public static final BatchNodeState IDLE

The Compute Node is not currently running a Task.

LEAVING_POOL

public static final BatchNodeState LEAVING_POOL

The Compute Node is leaving the Pool, either because the user explicitly removed it or because the Pool is resizing or autoscaling down.

OFFLINE

public static final BatchNodeState OFFLINE

The Compute Node is not currently running a Task, and scheduling of new Tasks to the Compute Node is disabled.

PREEMPTED

public static final BatchNodeState PREEMPTED

The Spot/Low-priority Compute Node has been preempted. Tasks which were running on the Compute Node when it was preempted will be rescheduled when another Compute Node becomes available.

REBOOTING

public static final BatchNodeState REBOOTING

The Compute Node is rebooting.

REIMAGING

public static final BatchNodeState REIMAGING

The Compute Node is reimaging.

RUNNING

public static final BatchNodeState RUNNING

The Compute Node is running one or more Tasks (other than a StartTask).

STARTING

public static final BatchNodeState STARTING

The Batch service is starting on the underlying virtual machine.

START_TASK_FAILED

public static final BatchNodeState START_TASK_FAILED

The StartTask has failed on the Compute Node (and exhausted all retries), and waitForSuccess is set. The Compute Node is not usable for running Tasks.

UNKNOWN

public static final BatchNodeState UNKNOWN

The Batch service has lost contact with the Compute Node, and does not know its true state.

UNUSABLE

public static final BatchNodeState UNUSABLE

The Compute Node cannot be used for Task execution due to errors.

UPGRADING_OS

public static final BatchNodeState UPGRADING_OS

The Compute Node is undergoing an OS upgrade operation.

WAITING_FOR_START_TASK

public static final BatchNodeState WAITING_FOR_START_TASK

The StartTask has started running on the Compute Node, but waitForSuccess is set and the StartTask has not yet completed.

Constructor Details

BatchNodeState

@Deprecated
public BatchNodeState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchNodeState value.

Method Details

fromString

public static BatchNodeState fromString(String name)

Creates or finds a BatchNodeState from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding BatchNodeState.

values

public static Collection<BatchNodeState> values()

Gets known BatchNodeState values.

Returns:

known BatchNodeState values.

Applies to