Package org.opensearch.client.opensearch._global

Class TermsEnumRequest

java.lang.Object
org.opensearch.client.opensearch._types.RequestBase
org.opensearch.client.opensearch._global.TermsEnumRequest
All Implemented Interfaces:
ToJsonp
public final class TermsEnumRequest
extends RequestBase
implements ToJsonp

  • Field Details

  • Constructor Details

  • Method Details

    • index

      public java.lang.String index()
      Comma-separated list of data streams, indices, and index aliases to search. Wildcard (*) expressions are supported. API name: index

    • field

      public java.lang.String field()
      The string to match at the start of indexed terms. If not provided, all terms in the field are considered. API name: field

    • size

      @Nullable public java.lang.Number size()
      How many matching terms to return. API name: size

    • timeout

      @Nullable public jakarta.json.JsonValue 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

    • caseInsensitive

      @Nullable public java.lang.Boolean caseInsensitive()
      When true the provided search string is matched against index terms without case sensitivity. API name: case_insensitive

    • indexFilter

      @Nullable public QueryContainer indexFilter()
      Allows to filter an index shard if the provided query rewrites to match_none. API name: index_filter

    • string

      @Nullable public 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

    • searchAfter

      @Nullable public java.lang.String searchAfter()
      API name: search_after

    • toJsonp

      public void toJsonp​(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
      Serialize this object to JSON.
      Specified by:
      toJsonp in interface ToJsonp

    • toJsonpInternal

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

    • setupTermsEnumRequestDeserializer

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