org.gridgain.grid
Enum GridTaskSessionScope

java.lang.Object
  java.lang.Enum<GridTaskSessionScope>
      org.gridgain.grid.GridTaskSessionScope

All Implemented Interfaces:

Serializable, Comparable<GridTaskSessionScope>

public enum GridTaskSessionScope
extends Enum<GridTaskSessionScope>

Defines life-time scopes for checkpoint operations. Such operations include:

• GridTaskSession.saveCheckpoint(String, Object, GridTaskSessionScope , long)

Enum Constant Summary

GLOBAL_SCOPE
Data saved with this scope will only be removed automatically if they time out and time out is supported.

SESSION_SCOPE
Data saved with this scope will be automatically removed once the task session is completed (i.e. execution of the task is completed) or when they time out.

Method Summary

static GridTaskSessionScope	fromOrdinal(byte ord) Efficiently gets enumerated value from its ordinal.
static GridTaskSessionScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static GridTaskSessionScope[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SESSION_SCOPE

public static final GridTaskSessionScope SESSION_SCOPE

Data saved with this scope will be automatically removed once the task session is completed (i.e. execution of the task is completed) or when they time out. This is the most often used scope for checkpoints and swap space. It provides behavior for use case when jobs can failover on other nodes within the same session and thus checkpoints or data saved to swap space should be preserved for the duration of the entire session.

GLOBAL_SCOPE

public static final GridTaskSessionScope GLOBAL_SCOPE

Data saved with this scope will only be removed automatically if they time out and time out is supported. Currently, only checkpoints support timeouts. Any data, however, can always be removed programmatically via methods on GridTaskSession interface.

Method Detail

values

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

Returns:

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

valueOf

public static GridTaskSessionScope 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.)

Throws:

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

NullPointerException - if the argument is null

Parameters:

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

Returns:

the enum constant with the specified name

fromOrdinal

@Nullable
public static GridTaskSessionScope fromOrdinal(byte ord)

Efficiently gets enumerated value from its ordinal.

Parameters:

ord - Ordinal value.

Returns:

Enumerated value.