Package org.opensearch.index.query

Enum IntervalMode

java.lang.Object

java.lang.Enum<IntervalMode>

org.opensearch.index.query.IntervalMode

All Implemented Interfaces:

Serializable, Comparable<IntervalMode>, org.opensearch.core.common.io.stream.Writeable

@PublicApi(since="1.0.0")
public enum IntervalMode
extends Enum<IntervalMode>
implements org.opensearch.core.common.io.stream.Writeable

Mode for Text and Mapped Field Types

Opensearch.api:

Nested Class Summary

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

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ORDERED
UNORDERED
UNORDERED_NO_OVERLAP

Method Summary

Modifier and Type	Method	Description
static IntervalMode	fromString(String intervalMode)
static IntervalMode	readFromStream(org.opensearch.core.common.io.stream.StreamInput in)
static IntervalMode	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IntervalMode[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ORDERED

public static final IntervalMode ORDERED

UNORDERED

public static final IntervalMode UNORDERED

UNORDERED_NO_OVERLAP

public static final IntervalMode UNORDERED_NO_OVERLAP

Method Details

values

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

readFromStream

public static IntervalMode readFromStream(org.opensearch.core.common.io.stream.StreamInput in)
                                   throws IOException

Throws:

IOException

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

fromString

public static IntervalMode fromString(String intervalMode)