Package com.linkedin.venice.stats.dimensions

Enum Class VeniceDIVResult

java.lang.Object

java.lang.Enum<VeniceDIVResult>

com.linkedin.venice.stats.dimensions.VeniceDIVResult

All Implemented Interfaces:

VeniceDimensionInterface, Serializable, Comparable<VeniceDIVResult>, Constable

public enum VeniceDIVResult
extends Enum<VeniceDIVResult>
implements VeniceDimensionInterface

Dimension enum representing the result of a Data Integrity Validation (DIV) check on a message. Maps to VeniceMetricsDimensions.VENICE_DIV_RESULT.

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
CORRUPTED	Running checksum mismatch detected at end-of-segment — segment data is corrupt.
DUPLICATE	Incoming sequence number is equal to or smaller than the previous — message already consumed.
MISSING	Incoming sequence number is greater than expected — one or more messages were skipped.
SUCCESS	Message passed all DIV checks (sequence number and checksum validation) successfully.

Method Summary

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

Methods inherited from interface com.linkedin.venice.stats.dimensions.VeniceDimensionInterface

getDimensionValue

Enum Constant Details

SUCCESS

public static final VeniceDIVResult SUCCESS

Message passed all DIV checks (sequence number and checksum validation) successfully.

DUPLICATE

public static final VeniceDIVResult DUPLICATE

Incoming sequence number is equal to or smaller than the previous — message already consumed.

MISSING

public static final VeniceDIVResult MISSING

Incoming sequence number is greater than expected — one or more messages were skipped.

CORRUPTED

public static final VeniceDIVResult CORRUPTED

Running checksum mismatch detected at end-of-segment — segment data is corrupt.

Method Details

values

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

getDimensionName

public VeniceMetricsDimensions getDimensionName()

Description copied from interface: VeniceDimensionInterface

Dimension name: Returns the VeniceMetricsDimensions for the enum. All the instances of a Enum class should have the same dimension name. Ideally this could have been a static variable/method in the Enum class, but to enforce having this method via this interface, it is made as a non-static method.

Specified by:

getDimensionName in interface VeniceDimensionInterface