org.gridgain.grid
Enum GridCheckpointScope

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

All Implemented Interfaces:

Serializable, Comparable<GridCheckpointScope>

@Apache20LicenseCompatible
public enum GridCheckpointScope
extends Enum<GridCheckpointScope>

This enumeration defines different life-time scopes for checkpoints. Checkpoints can be saved through:

• GridTaskSession.saveCheckpoint(String, Serializable, GridCheckpointScope, long)

See Also:

Documentation
Email Support
Online Forums
Issue Tracking

Author: 2005-2008 Copyright © GridGain Systems. All Rights Reserved. ver. 2.0.3

	Nikita Ivanov, GridGain Systems nivanov@gridgain.com
	Dmitriy Setrakyan, GridGain Systems dsetrakyan@gridgain.com
	Alexander Magdenko, GridGain Systems amagdenko@gridgain.com
	Boris Suchodoev, GridGain Systems bsuchodoev@gridgain.com
	Denis Kharlamov, GridGain Systems dkharlamov@gridgain.com
	close

Enum Constant Summary

GLOBAL_SCOPE
Checkpoints saved with this scope will only be removed automatically if they time out.

SESSION_SCOPE
Checkpoints 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 GridCheckpointScope	valueOf(String name) Returns the enum constant of this type with the specified name.
static GridCheckpointScope[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SESSION_SCOPE

public static final GridCheckpointScope SESSION_SCOPE

Checkpoints 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. It provides behavior for use case when jobs can failover on other nodes within the same session and thus checkpoints should be preserved for the duration of the entire session.

GLOBAL_SCOPE

public static final GridCheckpointScope GLOBAL_SCOPE

Checkpoints saved with this scope will only be removed automatically if they time out. User can always remove them manually.

Method Detail

values

public static final GridCheckpointScope[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(GridCheckpointScope c : GridCheckpointScope.values())
        System.out.println(c);

Returns:

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

valueOf

public static GridCheckpointScope 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

Parameters:

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

Returns:

the enum constant with the specified name