BatchNodeDeallocationOption Class

public final class BatchNodeDeallocationOption
extends ExpandableStringEnum<BatchNodeDeallocationOption>

BatchNodeDeallocationOption enums.

Field Summary

Modifier and Type Field and Description
static final BatchNodeDeallocationOption REQUEUE

Terminate running Task processes and requeue the Tasks.

static final BatchNodeDeallocationOption RETAINED_DATA

Deprecated, we encourage you to upload task data to Azure Storage in your task and use `TaskCompletion` instead.

static final BatchNodeDeallocationOption TASK_COMPLETION

Allow currently running Tasks to complete.

static final BatchNodeDeallocationOption TERMINATE

Terminate running Tasks.

Constructor Summary

Constructor Description
BatchNodeDeallocationOption()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchNodeDeallocationOption value.

Method Summary

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

Creates or finds a BatchNodeDeallocationOption from its string representation.

static Collection<BatchNodeDeallocationOption> values()

Gets known BatchNodeDeallocationOption values.

Methods inherited from ExpandableStringEnum

Methods inherited from java.lang.Object

Field Details

REQUEUE

public static final BatchNodeDeallocationOption REQUEUE

Terminate running Task processes and requeue the Tasks. The Tasks will run again when a Compute Node is available. Remove Compute Nodes as soon as Tasks have been terminated.

RETAINED_DATA

public static final BatchNodeDeallocationOption RETAINED_DATA

Deprecated, we encourage you to upload task data to Azure Storage in your task and use `TaskCompletion` instead. Allow currently running Tasks to complete, then wait for all Task data retention periods to expire. Schedule no new Tasks while waiting. Remove Compute Nodes when all Task retention periods have expired.

TASK_COMPLETION

public static final BatchNodeDeallocationOption TASK_COMPLETION

Allow currently running Tasks to complete. Schedule no new Tasks while waiting. Remove Compute Nodes when all Tasks have completed.

TERMINATE

public static final BatchNodeDeallocationOption TERMINATE

Terminate running Tasks. The Tasks will be completed with failureInfo indicating that they were terminated, and will not run again. Remove Compute Nodes as soon as Tasks have been terminated.

Constructor Details

BatchNodeDeallocationOption

@Deprecated
public BatchNodeDeallocationOption()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of BatchNodeDeallocationOption value.

Method Details

fromString

public static BatchNodeDeallocationOption fromString(String name)

Creates or finds a BatchNodeDeallocationOption from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding BatchNodeDeallocationOption.

values

public static Collection<BatchNodeDeallocationOption> values()

Gets known BatchNodeDeallocationOption values.

Returns:

known BatchNodeDeallocationOption values.

Applies to