Package software.amazon.awssdk.services.kendra.model

Enum MetricType

java.lang.Object

java.lang.Enum<MetricType>

software.amazon.awssdk.services.kendra.model.MetricType

All Implemented Interfaces:

Serializable, Comparable<MetricType>

@Generated("software.amazon.awssdk:codegen")
public enum MetricType
extends Enum<MetricType>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AGG_QUERY_DOC_METRICS
DOCS_BY_CLICK_COUNT
QUERIES_BY_COUNT
QUERIES_BY_ZERO_CLICK_RATE
QUERIES_BY_ZERO_RESULT_RATE
TREND_QUERY_DOC_METRICS
UNKNOWN_TO_SDK_VERSION

Method Summary

Modifier and Type	Method	Description
static MetricType	fromValue(String value)	Use this in place of valueOf to convert the raw string returned by the service into the enum value.
static Set<MetricType>	knownValues()	Use this in place of values() to return a Set of all values known to the SDK.
String	toString()
static MetricType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static MetricType[]	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 Detail

QUERIES_BY_COUNT

public static final MetricType QUERIES_BY_COUNT

QUERIES_BY_ZERO_CLICK_RATE

public static final MetricType QUERIES_BY_ZERO_CLICK_RATE

QUERIES_BY_ZERO_RESULT_RATE

public static final MetricType QUERIES_BY_ZERO_RESULT_RATE

DOCS_BY_CLICK_COUNT

public static final MetricType DOCS_BY_CLICK_COUNT

AGG_QUERY_DOC_METRICS

public static final MetricType AGG_QUERY_DOC_METRICS

TREND_QUERY_DOC_METRICS

public static final MetricType TREND_QUERY_DOC_METRICS

UNKNOWN_TO_SDK_VERSION

public static final MetricType UNKNOWN_TO_SDK_VERSION

Method Detail

values

public static MetricType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MetricType c : MetricType.values())
    System.out.println(c);

Returns:

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

valueOf

public static MetricType 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<MetricType>

fromValue

public static MetricType fromValue(String value)

Use this in place of valueOf to convert the raw string returned by the service into the enum value.

Parameters:

value - real value

Returns:

MetricType corresponding to the value

knownValues

public static Set<MetricType> knownValues()

Use this in place of values() to return a Set of all values known to the SDK. This will return all known enum values except UNKNOWN_TO_SDK_VERSION.

Returns:

a Set of known MetricTypes