Package org.opensearch.plugin.insights.rules.model

Enum Attribute

java.lang.Object

java.lang.Enum<Attribute>

org.opensearch.plugin.insights.rules.model.Attribute

All Implemented Interfaces:

Serializable, Comparable<Attribute>

public enum Attribute
extends Enum<Attribute>

Valid attributes for a search query record

Opensearch.internal:

Enum Constant Summary

Enum Constants

Enum Constant	Description
INDICES	The indices involved
NODE_ID	The node id for this request
PHASE_LATENCY_MAP	The per phase level latency map for a search query
SEARCH_TYPE	The search query type
SOURCE	The search query source
TOTAL_SHARDS	Total shards queried

Method Summary

Modifier and Type	Method	Description
String	toString()
static Attribute	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Attribute[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SEARCH_TYPE

public static final Attribute SEARCH_TYPE

The search query type

SOURCE

public static final Attribute SOURCE

The search query source

TOTAL_SHARDS

public static final Attribute TOTAL_SHARDS

Total shards queried

INDICES

public static final Attribute INDICES

The indices involved

PHASE_LATENCY_MAP

public static final Attribute PHASE_LATENCY_MAP

The per phase level latency map for a search query

NODE_ID

public static final Attribute NODE_ID

The node id for this request

Method Details

values

public static Attribute[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static Attribute valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

toString

public String toString()

Overrides:

toString in class Enum<Attribute>