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

Enum ComputeNodeDeallocationOption

java.lang.Object

java.lang.Enum<ComputeNodeDeallocationOption>

com.microsoft.azure.batch.protocol.models.ComputeNodeDeallocationOption

All Implemented Interfaces:

Serializable, Comparable<ComputeNodeDeallocationOption>

public enum ComputeNodeDeallocationOption
extends Enum<ComputeNodeDeallocationOption>

Defines values for ComputeNodeDeallocationOption.

Enum Constant Summary

Enum Constants

Enum Constant	Description
REQUEUE	Terminate running Task processes and requeue the Tasks.
RETAINED_DATA	Allow currently running Tasks to complete, then wait for all Task data retention periods to expire.
TASK_COMPLETION	Allow currently running Tasks to complete.
TERMINATE	Terminate running Tasks.

Method Summary

Modifier and Type	Method	Description
static ComputeNodeDeallocationOption	fromString(String value)	Parses a serialized value to a ComputeNodeDeallocationOption instance.
String	toString()
static ComputeNodeDeallocationOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ComputeNodeDeallocationOption[]	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

REQUEUE

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

TERMINATE

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

TASK_COMPLETION

public static final ComputeNodeDeallocationOption TASK_COMPLETION

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

RETAINED_DATA

public static final ComputeNodeDeallocationOption RETAINED_DATA

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.

Method Detail

values

public static ComputeNodeDeallocationOption[] 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 (ComputeNodeDeallocationOption c : ComputeNodeDeallocationOption.values())
    System.out.println(c);

Returns:

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

valueOf

public static ComputeNodeDeallocationOption 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 ComputeNodeDeallocationOption fromString(String value)

Parses a serialized value to a ComputeNodeDeallocationOption instance.

Parameters:

value - the serialized value to parse.

Returns:

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

toString

public String toString()

Overrides:

toString in class Enum<ComputeNodeDeallocationOption>