Package com.linkedin.venice.stats.dimensions

Enum Class VeniceRegionLocality

java.lang.Object

java.lang.Enum<VeniceRegionLocality>

com.linkedin.venice.stats.dimensions.VeniceRegionLocality

All Implemented Interfaces:

VeniceDimensionInterface, Serializable, Comparable<VeniceRegionLocality>, Constable

public enum VeniceRegionLocality
extends Enum<VeniceRegionLocality>
implements VeniceDimensionInterface

Dimension to represent whether a region is local or remote.

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
LOCAL	The region is the same as the current server's region
REMOTE	The region is different from the current server's region

Method Summary

Modifier and Type	Method	Description
VeniceMetricsDimensions	getDimensionName()	All the instances of this Enum should have the same dimension name.
String	getDimensionValue()	Dimension value: Returns the dimension value for each enum instance.
static VeniceRegionLocality	valueOf(String name)	Returns the enum constant of this class with the specified name.
static VeniceRegionLocality[]	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

LOCAL

public static final VeniceRegionLocality LOCAL

The region is the same as the current server's region

REMOTE

public static final VeniceRegionLocality REMOTE

The region is different from the current server's region

Method Details

values

public static VeniceRegionLocality[] 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 VeniceRegionLocality 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()

All the instances of this Enum should have the same dimension name. Refer VeniceDimensionInterface.getDimensionName() for more details.

Specified by:

getDimensionName in interface VeniceDimensionInterface

getDimensionValue

public String getDimensionValue()

Description copied from interface: VeniceDimensionInterface

Dimension value: Returns the dimension value for each enum instance.

Specified by:

getDimensionValue in interface VeniceDimensionInterface