Package com.linkedin.venice.meta

Enum Class IngestionPauseMode

java.lang.Object

java.lang.Enum<IngestionPauseMode>

com.linkedin.venice.meta.IngestionPauseMode

All Implemented Interfaces:

VeniceEnumValue, Serializable, Comparable<IngestionPauseMode>, Constable

public enum IngestionPauseMode
extends Enum<IngestionPauseMode>
implements VeniceEnumValue

Enums of the ingestion pause modes for Venice stores. Used as an operational lever during incident response to pause Kafka consumption.

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
ALL_VERSIONS	Pause ingestion for ALL versions, including the current serving version's RT and VT consumption.
CURRENT_VERSION	Pause ingestion for the current serving version's RT consumption only.
NOT_PAUSED	Default.

Method Summary

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

NOT_PAUSED

public static final IngestionPauseMode NOT_PAUSED

Default. All ingestion runs normally.

CURRENT_VERSION

public static final IngestionPauseMode CURRENT_VERSION

Pause ingestion for the current serving version's RT consumption only. Non-current versions (future pushes, backup versions) are not affected.

ALL_VERSIONS

public static final IngestionPauseMode ALL_VERSIONS

Pause ingestion for ALL versions, including the current serving version's RT and VT consumption.

Method Details

values

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

fromInt

public static IngestionPauseMode fromInt(int i)

getValue

public int getValue()

Specified by:

getValue in interface VeniceEnumValue