Package org.opensearch.client.opensearch.core

Class TermsEnumRequest

java.lang.Object

org.opensearch.client.opensearch._types.RequestBase

org.opensearch.client.opensearch.core.TermsEnumRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class TermsEnumRequest
extends RequestBase
implements JsonpSerializable

The terms enum API can be used to discover terms in the index that begin with the provided string. It is designed for low-latency look-ups used in auto-complete scenarios.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TermsEnumRequest.Builder	Builder for TermsEnumRequest.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static JsonpDeserializer<TermsEnumRequest>	_DESERIALIZER	Json deserializer for TermsEnumRequest
static Endpoint<TermsEnumRequest,TermsEnumResponse,ErrorResponse>	_ENDPOINT	Endpoint "terms_enum".

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	caseInsensitive()	When true the provided search string is matched against index terms without case sensitivity.
java.lang.String	field()	Required - The string to match at the start of indexed terms.
java.lang.String	index()	Required - Comma-separated list of data streams, indices, and index aliases to search.
Query	indexFilter()	Allows to filter an index shard if the provided query rewrites to match_none.
static TermsEnumRequest	of(java.util.function.Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)
java.lang.String	searchAfter()	API name: search_after
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupTermsEnumRequestDeserializer(ObjectDeserializer<TermsEnumRequest.Builder> op)
java.lang.Integer	size()	How many matching terms to return.
java.lang.String	string()	The string after which terms in the index should be returned.
Time	timeout()	The maximum length of time to spend collecting results.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

_DESERIALIZER

public static final JsonpDeserializer<TermsEnumRequest> _DESERIALIZER

Json deserializer for TermsEnumRequest

_ENDPOINT

public static final Endpoint<TermsEnumRequest,TermsEnumResponse,ErrorResponse> _ENDPOINT

Endpoint "terms_enum".

Method Detail

of

public static TermsEnumRequest of(java.util.function.Function<TermsEnumRequest.Builder,ObjectBuilder<TermsEnumRequest>> fn)

caseInsensitive

@Nullable
public final java.lang.Boolean caseInsensitive()

When true the provided search string is matched against index terms without case sensitivity.

API name: case_insensitive

field

public final java.lang.String field()

Required - The string to match at the start of indexed terms. If not provided, all terms in the field are considered.

API name: field

index

public final java.lang.String index()

Required - Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported.

API name: index

indexFilter

@Nullable
public final Query indexFilter()

Allows to filter an index shard if the provided query rewrites to match_none.

API name: index_filter

searchAfter

@Nullable
public final java.lang.String searchAfter()

API name: search_after

size

@Nullable
public final java.lang.Integer size()

How many matching terms to return.

API name: size

string

@Nullable
public final java.lang.String string()

The string after which terms in the index should be returned. Allows for a form of pagination if the last result from one request is passed as the search_after parameter for a subsequent request.

API name: string

timeout

@Nullable
public final Time timeout()

The maximum length of time to spend collecting results. Defaults to "1s" (one second). If the timeout is exceeded the complete flag set to false in the response and the results may be partial or empty.

API name: timeout

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
                      JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
                                 JsonpMapper mapper)

setupTermsEnumRequestDeserializer

protected static void setupTermsEnumRequestDeserializer(ObjectDeserializer<TermsEnumRequest.Builder> op)