Package org.opensearch.client.opensearch._types

Enum SearchType

java.lang.Object

java.lang.Enum<SearchType>

org.opensearch.client.opensearch._types.SearchType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SearchType>, JsonEnum, JsonpSerializable

@JsonpDeserializable
public enum SearchType
extends java.lang.Enum<SearchType>
implements JsonEnum

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
DfsQueryThenFetch	Documents are scored using global term and document frequencies across all shards.
QueryThenFetch	Documents are scored using local term and document frequencies for the shard.

Field Summary

Fields

Modifier and Type	Field	Description
static JsonEnum.Deserializer<SearchType>	_DESERIALIZER

Method Summary

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

QueryThenFetch

public static final SearchType QueryThenFetch

Documents are scored using local term and document frequencies for the shard. This is usually faster but less accurate.

DfsQueryThenFetch

public static final SearchType DfsQueryThenFetch

Documents are scored using global term and document frequencies across all shards. This is usually slower but more accurate.

Field Detail

_DESERIALIZER

public static final JsonEnum.Deserializer<SearchType> _DESERIALIZER

Method Detail

values

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

Returns:

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

valueOf

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