Module org.elasticsearch.server

Package org.elasticsearch.action.downsample

Enum Class DownsampleConfig.SamplingMethod

java.lang.Object

java.lang.Enum<DownsampleConfig.SamplingMethod>

org.elasticsearch.action.downsample.DownsampleConfig.SamplingMethod

All Implemented Interfaces:

Serializable, Comparable<DownsampleConfig.SamplingMethod>, Constable, Writeable

Enclosing class:

DownsampleConfig

public static enum DownsampleConfig.SamplingMethod
extends Enum<DownsampleConfig.SamplingMethod>
implements Writeable

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AGGREGATE
LAST_VALUE

Method Summary

Modifier and Type	Method	Description
static DownsampleConfig.SamplingMethod	fromIndexMetadata(IndexMetadata indexMetadata)	Retrieves the configured sampling method from the index metadata.
static DownsampleConfig.SamplingMethod	fromString(String label)	Parses the configured sampling method from string (case-insensitive).
static DownsampleConfig.SamplingMethod	getOrDefault(DownsampleConfig.SamplingMethod samplingMethod)
static DownsampleConfig.SamplingMethod	read(StreamInput in)
String	toString()
static DownsampleConfig.SamplingMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DownsampleConfig.SamplingMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AGGREGATE

public static final DownsampleConfig.SamplingMethod AGGREGATE

LAST_VALUE

public static final DownsampleConfig.SamplingMethod LAST_VALUE

Method Details

values

public static DownsampleConfig.SamplingMethod[] 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 DownsampleConfig.SamplingMethod 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

read

public static DownsampleConfig.SamplingMethod read(StreamInput in)
                                            throws IOException

Throws:

IOException

fromString

@Nullable
public static DownsampleConfig.SamplingMethod fromString(@Nullable
 String label)

Parses the configured sampling method from string (case-insensitive).

Returns:

the used sampling method, or null when the label is null.

fromIndexMetadata

@Nullable
public static DownsampleConfig.SamplingMethod fromIndexMetadata(IndexMetadata indexMetadata)

Retrieves the configured sampling method from the index metadata. In case that it is null, it checks if the index is downsampled and returns the `aggregate` that was the only sampling method before we introduced last value.

Returns:

the used sampling method, or null if the index is not downsampled.

getOrDefault

public static DownsampleConfig.SamplingMethod getOrDefault(@Nullable
 DownsampleConfig.SamplingMethod samplingMethod)

Returns:

the sampling method that will be used based on this configuration. Default to AGGREGATE when the provided sampling method is null.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Enum<DownsampleConfig.SamplingMethod>