Share via

ComputeNodeState Enum

  • Reference
Package:
com.microsoft.azure.batch.protocol.models
Maven Artifact:
com.microsoft.azure:azure-batch:11.1.1
  • java.lang.Object
    • java.lang.Enum
      • com.microsoft.azure.batch.protocol.models.ComputeNodeState

public enum ComputeNodeState
extends Enum<ComputeNodeState>

Defines values for ComputeNodeState.

Fields

CREATING

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

The Compute Node is not currently running a Task.
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

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

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

The Compute Node is rebooting.
REIMAGING

The Compute Node is reimaging.
RUNNING

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

The Batch service is starting on the underlying virtual machine.
START_TASK_FAILED

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

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

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

The Compute Node is undergoing an OS upgrade operation.
WAITING_FOR_START_TASK

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

Methods inherited from java.lang.Enum

valueOf clone compareTo equals finalize getDeclaringClass hashCode name ordinal toString

Methods inherited from java.lang.Object

getClass notify notifyAll wait wait wait

Methods

fromString(String value)

public static ComputeNodeState fromString(String value)

Parses a serialized value to a ComputeNodeState instance.

Parameters

value
String
the serialized value to parse.

Returns

ComputeNodeState
the parsed ComputeNodeState object, or null if unable to parse.

toString()

public String toString()

Returns

String
Overrides
java.lang.Enum.toString()

valueOf(String name)

public static ComputeNodeState valueOf(String name)

Parameters

name
String

Returns

ComputeNodeState

values()

public static ComputeNodeState[] values()

Returns

ComputeNodeState[]

Applies to