Package co.elastic.clients.elasticsearch.core

Class TermsEnumRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<TermsEnumRequest.Builder>
co.elastic.clients.elasticsearch.core.TermsEnumRequest.Builder
All Implemented Interfaces:
WithJson<TermsEnumRequest.Builder>, ObjectBuilder<TermsEnumRequest>
Enclosing class:
TermsEnumRequest
public static class TermsEnumRequest.Builder extends RequestBase.AbstractBuilder<TermsEnumRequest.Builder> implements ObjectBuilder<TermsEnumRequest>
Builder for TermsEnumRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • caseInsensitive

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

      API name: case_insensitive

    • field

      public final TermsEnumRequest.Builder field(String value)
      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 TermsEnumRequest.Builder index(String value)
      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

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

      API name: index_filter

    • indexFilter

      public final TermsEnumRequest.Builder indexFilter(Function<Query.Builder,ObjectBuilder<Query>> fn)
      Filter an index shard if the provided query rewrites to match_none.

      API name: index_filter

    • indexFilter

      public final TermsEnumRequest.Builder indexFilter(QueryVariant value)
      Filter an index shard if the provided query rewrites to match_none.

      API name: index_filter

    • searchAfter

      public final TermsEnumRequest.Builder searchAfter(@Nullable String value)
      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

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

      API name: size

    • string

      public final TermsEnumRequest.Builder string(@Nullable String value)
      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

      public final TermsEnumRequest.Builder timeout(@Nullable Time value)
      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

    • timeout

      public final TermsEnumRequest.Builder timeout(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

    • self

      protected TermsEnumRequest.Builder self()
      Specified by:
      self in class RequestBase.AbstractBuilder<TermsEnumRequest.Builder>

    • build

      public TermsEnumRequest build()
      Builds a TermsEnumRequest.
      Specified by:
      build in interface ObjectBuilder<TermsEnumRequest>
      Throws:
      NullPointerException - if some of the required fields are null.