Package org.opensearch.client.opensearch._types.query_dsl

Enum SpanQuery.Kind

java.lang.Object

java.lang.Enum<SpanQuery.Kind>

org.opensearch.client.opensearch._types.query_dsl.SpanQuery.Kind

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SpanQuery.Kind>, JsonEnum, JsonpSerializable

Enclosing class:

SpanQuery

public static enum SpanQuery.Kind
extends java.lang.Enum<SpanQuery.Kind>
implements JsonEnum

SpanQuery variant kinds.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.json.JsonEnum

JsonEnum.Deserializer<T extends JsonEnum>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FieldMaskingSpan
SpanContaining
SpanFirst
SpanGap
SpanMulti
SpanNear
SpanNot
SpanOr
SpanTerm
SpanWithin

Method Summary

Modifier and Type	Method	Description
java.lang.String	jsonValue()
static SpanQuery.Kind	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static SpanQuery.Kind[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.JsonEnum

aliases, serialize

Enum Constant Detail

SpanContaining

public static final SpanQuery.Kind SpanContaining

FieldMaskingSpan

public static final SpanQuery.Kind FieldMaskingSpan

SpanFirst

public static final SpanQuery.Kind SpanFirst

SpanGap

public static final SpanQuery.Kind SpanGap

SpanMulti

public static final SpanQuery.Kind SpanMulti

SpanNear

public static final SpanQuery.Kind SpanNear

SpanNot

public static final SpanQuery.Kind SpanNot

SpanOr

public static final SpanQuery.Kind SpanOr

SpanTerm

public static final SpanQuery.Kind SpanTerm

SpanWithin

public static final SpanQuery.Kind SpanWithin

Method Detail

values

public static SpanQuery.Kind[] 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 (SpanQuery.Kind c : SpanQuery.Kind.values())
    System.out.println(c);

Returns:

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

valueOf

public static SpanQuery.Kind valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

jsonValue

public java.lang.String jsonValue()

Specified by:

jsonValue in interface JsonEnum