Package com.linkedin.venice.samza

Enum Class SamzaExitMode

java.lang.Object

java.lang.Enum<SamzaExitMode>

com.linkedin.venice.samza.SamzaExitMode

All Implemented Interfaces:

Serializable, Comparable<SamzaExitMode>, Constable

public enum SamzaExitMode
extends Enum<SamzaExitMode>

Various methods for stopping/exiting a Samza task.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
NO_OP	Do nothing; this mode is mostly used in test cases.
SUCCESS_EXIT	Directly exit the Samza process with status code 0, which should be only used by stream reprocessing job; besides, status 0 will leave a green mark for Samza task, so this mode should be used when the stream reprocessing job succeeds.
THROW_ERROR_EXCEPTION	Stop the Samza task by keep throwing exception.

Method Summary

Modifier and Type	Method	Description
void	exit()
static SamzaExitMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SamzaExitMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS_EXIT

public static final SamzaExitMode SUCCESS_EXIT

Directly exit the Samza process with status code 0, which should be only used by stream reprocessing job; besides, status 0 will leave a green mark for Samza task, so this mode should be used when the stream reprocessing job succeeds.

THROW_ERROR_EXCEPTION

public static final SamzaExitMode THROW_ERROR_EXCEPTION

Stop the Samza task by keep throwing exception.

NO_OP

public static final SamzaExitMode NO_OP

Do nothing; this mode is mostly used in test cases.

Method Details

values

public static SamzaExitMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static SamzaExitMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

exit

public void exit()