Package com.redis.vl.extensions.router

Enum Class DistanceAggregationMethod

java.lang.Object

java.lang.Enum<DistanceAggregationMethod>

com.redis.vl.extensions.router.DistanceAggregationMethod

All Implemented Interfaces:

Serializable, Comparable<DistanceAggregationMethod>, Constable

public enum DistanceAggregationMethod
extends Enum<DistanceAggregationMethod>

Enumeration for distance aggregation methods. Ported from Python: redisvl/extensions/router/schema.py:50

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
AVG	Average aggregation method
MIN	Minimum aggregation method
SUM	Sum aggregation method

Method Summary

Modifier and Type	Method	Description
static DistanceAggregationMethod	fromValue(String value)	Get the DistanceAggregationMethod from a string value.
String	getValue()	Get the string value of the aggregation method.
static DistanceAggregationMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DistanceAggregationMethod[]	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

AVG

public static final DistanceAggregationMethod AVG

Average aggregation method

MIN

public static final DistanceAggregationMethod MIN

Minimum aggregation method

SUM

public static final DistanceAggregationMethod SUM

Sum aggregation method

Method Details

values

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

getValue

public String getValue()

Get the string value of the aggregation method.

Returns:

the string value

fromValue

public static DistanceAggregationMethod fromValue(String value)

Get the DistanceAggregationMethod from a string value.

Parameters:

value - the string value

Returns:

the corresponding DistanceAggregationMethod

Throws:

IllegalArgumentException - if the value is unknown