Share via


BatchSubtaskState Class

public final class BatchSubtaskState
extends ExpandableStringEnum<BatchSubtaskState>

BatchSubtaskState enums.

Field Summary

Modifier and Type Field and Description
static final BatchSubtaskState 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 BatchSubtaskState 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 BatchSubtaskState RUNNING

The Task is running on a Compute Node.

Constructor Summary

Constructor Description
BatchSubtaskState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchSubtaskState value.

Method Summary

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

Creates or finds a BatchSubtaskState from its string representation.

static Collection<BatchSubtaskState> values()

Gets known BatchSubtaskState values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

COMPLETED

public static final BatchSubtaskState 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 BatchSubtaskState 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 BatchSubtaskState 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

BatchSubtaskState

@Deprecated
public BatchSubtaskState()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchSubtaskState value.

Method Details

fromString

public static BatchSubtaskState fromString(String name)

Creates or finds a BatchSubtaskState from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding BatchSubtaskState.

values

public static Collection<BatchSubtaskState> values()

Gets known BatchSubtaskState values.

Returns:

known BatchSubtaskState values.

Applies to