Package co.elastic.clients.elasticsearch.core

Class TermsEnumRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.TermsEnumRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class TermsEnumRequest extends RequestBase implements JsonpSerializable
Get terms in an index.

Discover terms that match a partial string in an index. This API is designed for low-latency look-ups used in auto-complete scenarios.

info The terms enum API may return terms from deleted documents. Deleted documents are initially only marked as deleted. It is not until their segments are merged that documents are actually deleted. Until that happens, the terms enum API will return terms from these documents.

See Also:

  • Field Details

  • Method Details

    • of

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

    • caseInsensitive

      @Nullable public final Boolean caseInsensitive()
      When true, the provided search string is matched against index terms without case sensitivity.

      API name: case_insensitive

    • field

      public final 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 String index()
      Required - A comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported. To search all data streams or indices, omit this parameter or use * or _all.

      API name: index

    • indexFilter

      @Nullable public final Query indexFilter()
      Filter an index shard if the provided query rewrites to match_none.

      API name: index_filter

    • searchAfter

      @Nullable public final String searchAfter()
      The string after which terms in the index should be returned. It 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: search_after

    • size

      @Nullable public final Integer size()
      The number of matching terms to return.

      API name: size

    • string

      @Nullable public final String string()
      The string to match at the start of indexed terms. If it is not provided, all terms in the field are considered.

      info The prefix string cannot be larger than the largest possible keyword value, which is Lucene's term byte-length limit of 32766.

      API name: string

    • timeout

      @Nullable public final Time timeout()
      The maximum length of time to spend collecting results. 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)