Package com.microsoft.azure.batch.protocol.models

Enum TaskState

java.lang.Object

java.lang.Enum<TaskState>

com.microsoft.azure.batch.protocol.models.TaskState

All Implemented Interfaces:

Serializable, Comparable<TaskState>

public enum TaskState
extends Enum<TaskState>

Defines values for TaskState.

Enum Constant Summary

Enum Constants

Enum Constant	Description
ACTIVE	The Task is queued and able to run, but is not currently assigned to a Compute Node.
COMPLETED	The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit.
PREPARING	The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node.
RUNNING	The Task is running on a Compute Node.

Method Summary

Modifier and Type	Method	Description
static TaskState	fromString(String value)	Parses a serialized value to a TaskState instance.
String	toString()
static TaskState	valueOf(String name)	Returns the enum constant of this type with the specified name.
static TaskState[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACTIVE

public static final TaskState ACTIVE

The Task is queued and able to run, but is not currently assigned to a Compute Node. A Task enters this state when it is created, when it is enabled after being disabled, or when it is awaiting a retry after a failed run.

PREPARING

public static final TaskState PREPARING

The Task has been assigned to a Compute Node, but is waiting for a required Job Preparation Task to complete on the Compute Node. If the Job Preparation Task succeeds, the Task will move to running. If the Job Preparation Task fails, the Task will return to active and will be eligible to be assigned to a different Compute Node.

RUNNING

public static final TaskState RUNNING

The Task is running on a Compute Node. This includes task-level preparation such as downloading resource files or deploying Packages specified on the Task - it does not necessarily mean that the Task command line has started executing.

COMPLETED

public static final TaskState COMPLETED

The Task is no longer eligible to run, usually because the Task has finished successfully, or the Task has finished unsuccessfully and has exhausted its retry limit. A Task is also marked as completed if an error occurred launching the Task, or when the Task has been terminated.

Method Detail

values

public static TaskState[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TaskState c : TaskState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TaskState valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromString

public static TaskState fromString(String value)

Parses a serialized value to a TaskState instance.

Parameters:

value - the serialized value to parse.

Returns:

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

toString

public String toString()

Overrides:

toString in class Enum<TaskState>