org.apache.samza.task

Enum TaskCoordinator.RequestScope

java.lang.Object

java.lang.Enum<TaskCoordinator.RequestScope>

org.apache.samza.task.TaskCoordinator.RequestScope

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TaskCoordinator.RequestScope>

Enclosing interface:

TaskCoordinator

public static enum TaskCoordinator.RequestScope
extends java.lang.Enum<TaskCoordinator.RequestScope>

A task can make requests to the Samza framework while processing messages, such as TaskCoordinator.commit(RequestScope) and TaskCoordinator.shutdown(RequestScope). This enum is used to indicate whether those requests apply only to the current task, or to all tasks in the current container.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ALL_TASKS_IN_CONTAINER Indicates that a request applies to all tasks in the current container.
CURRENT_TASK Indicates that a request applies only to the task making the call.

Method Summary

Methods

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

CURRENT_TASK

public static final TaskCoordinator.RequestScope CURRENT_TASK

Indicates that a request applies only to the task making the call.

ALL_TASKS_IN_CONTAINER

public static final TaskCoordinator.RequestScope ALL_TASKS_IN_CONTAINER

Indicates that a request applies to all tasks in the current container.

Method Detail

values

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

Returns:

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

valueOf

public static TaskCoordinator.RequestScope valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null