Package com.linkedin.venice.hooks

Enum Class StoreVersionLifecycleEventOutcome

java.lang.Object

java.lang.Enum<StoreVersionLifecycleEventOutcome>

com.linkedin.venice.hooks.StoreVersionLifecycleEventOutcome

All Implemented Interfaces:

Serializable, Comparable<StoreVersionLifecycleEventOutcome>, Constable

public enum StoreVersionLifecycleEventOutcome
extends Enum<StoreVersionLifecycleEventOutcome>

A hook which returns this enum has the option of proceeding, aborting, waiting or rolling back.

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
ABORT	Fail the push job associated with this hook.
PROCEED	Proceed, as if the hook did not exist.
ROLLBACK	Rollback to the store-version which was in effect prior to the start of the push job (i.e.
WAIT	Re-invoke the hook again some time in the future.

Method Summary

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

PROCEED

public static final StoreVersionLifecycleEventOutcome PROCEED

Proceed, as if the hook did not exist.

ABORT

public static final StoreVersionLifecycleEventOutcome ABORT

Fail the push job associated with this hook.

WAIT

public static final StoreVersionLifecycleEventOutcome WAIT

Re-invoke the hook again some time in the future.

ROLLBACK

public static final StoreVersionLifecycleEventOutcome ROLLBACK

Rollback to the store-version which was in effect prior to the start of the push job (i.e. other regions which already proceeded will kill the ongoing push if it is still in process, or rollback to the previous store-version, if the push already completed in that region).

Method Details

values

public static StoreVersionLifecycleEventOutcome[] 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 StoreVersionLifecycleEventOutcome 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