BatchTaskState Class

Package:: com.azure.compute.batch.models

Maven Artifact:: com.azure:azure-compute-batch:1.0.0-beta.5

java.lang.Object
- com.azure.core.util.ExpandableStringEnum<T>
- - com.azure.compute.batch.models.BatchTaskState

public final class BatchTaskState
extends ExpandableStringEnum<BatchTaskState>

BatchTaskState enums.

Field Summary

Modifier and Type	Field and Description
static final BatchTaskState	ACTIVE The Task is queued and able to run, but is not currently assigned to a Compute Node.
static final BatchTaskState	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.
static final BatchTaskState	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.
static final BatchTaskState	RUNNING The Task is running on a Compute Node.

Constructor Summary

Constructor	Description
BatchTaskState()	Deprecated Use the fromString(String name) factory method. Creates a new instance of BatchTaskState value.

Constructor

Description

BatchTaskState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchTaskState value.

Method Summary

Modifier and Type	Method and Description
static BatchTaskState	fromString(String name) Creates or finds a BatchTaskState from its string representation.
static Collection<BatchTaskState>	values() Gets known BatchTaskState values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

ACTIVE

public static final BatchTaskState 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.

COMPLETED

public static final BatchTaskState 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.

PREPARING

public static final BatchTaskState 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 BatchTaskState 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.

Constructor Details

BatchTaskState

@Deprecated
public BatchTaskState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchTaskState value.

Method Details

fromString

public static BatchTaskState fromString(String name)

Creates or finds a BatchTaskState from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding BatchTaskState.

values

public static Collection<BatchTaskState> values()

Gets known BatchTaskState values.