io.cdap.cdap.api.workflow

Enum WorkflowToken.Scope

java.lang.Object

java.lang.Enum<WorkflowToken.Scope>

io.cdap.cdap.api.workflow.WorkflowToken.Scope

All Implemented Interfaces:

Serializable, Comparable<WorkflowToken.Scope>

Enclosing interface:

WorkflowToken

public static enum WorkflowToken.Scope
extends Enum<WorkflowToken.Scope>

Keys in the WorkflowToken can be added by user, using the WorkflowToken.put(java.lang.String, java.lang.String) method. These keys are added under the USER scope. CDAP also adds some keys to the WorkflowToken. for e.g. MapReduce counters. The keys added by CDAP are added under the SYSTEM scope.

Enum Constant Summary

Enum Constants

Enum Constant and Description
SYSTEM
USER

Method Summary

Modifier and Type	Method and Description
static WorkflowToken.Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static WorkflowToken.Scope[]	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

USER

public static final WorkflowToken.Scope USER

SYSTEM

public static final WorkflowToken.Scope SYSTEM

Method Detail

values

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

Returns:

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

valueOf

public static WorkflowToken.Scope 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