Package com.linkedin.venice.stats.dimensions

Enum Class RequestFanoutType

java.lang.Object

java.lang.Enum<RequestFanoutType>

com.linkedin.venice.stats.dimensions.RequestFanoutType

All Implemented Interfaces:

VeniceDimensionInterface, Serializable, Comparable<RequestFanoutType>, Constable

public enum RequestFanoutType
extends Enum<RequestFanoutType>
implements VeniceDimensionInterface

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
ORIGINAL	Indicates the initial/original request sent by the client.
RETRY	Indicates a retry request sent by the client.

Method Summary

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

ORIGINAL

public static final RequestFanoutType ORIGINAL

Indicates the initial/original request sent by the client. Use this when the request is being made for the first time, not as a result of a retry.

RETRY

public static final RequestFanoutType RETRY

Indicates a retry request sent by the client. Use this when the request is being retried after a previous attempt failed or timed out.

Method Details

values

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

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