Package co.elastic.clients.elasticsearch.core

Class ExplainRequest.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • source

      public final ExplainRequest.Builder source​(@Nullable SourceConfigParam value)
      True or false to return the _source field or not, or a list of fields to return

      API name: _source

    • source

      public final ExplainRequest.Builder source​(java.util.function.Function<SourceConfigParam.Builder,​ObjectBuilder<SourceConfigParam>> fn)
      True or false to return the _source field or not, or a list of fields to return

      API name: _source

    • sourceExcludes

      public final ExplainRequest.Builder sourceExcludes​(java.util.List<java.lang.String> list)
      A list of fields to exclude from the returned _source field

      API name: _source_excludes

      Adds all elements of list to sourceExcludes.

    • sourceExcludes

      public final ExplainRequest.Builder sourceExcludes​(java.lang.String value, java.lang.String... values)
      A list of fields to exclude from the returned _source field

      API name: _source_excludes

      Adds one or more values to sourceExcludes.

    • sourceIncludes

      public final ExplainRequest.Builder sourceIncludes​(java.util.List<java.lang.String> list)
      A list of fields to extract and return from the _source field

      API name: _source_includes

      Adds all elements of list to sourceIncludes.

    • sourceIncludes

      public final ExplainRequest.Builder sourceIncludes​(java.lang.String value, java.lang.String... values)
      A list of fields to extract and return from the _source field

      API name: _source_includes

      Adds one or more values to sourceIncludes.

    • analyzeWildcard

      public final ExplainRequest.Builder analyzeWildcard​(@Nullable java.lang.Boolean value)
      Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)

      API name: analyze_wildcard

    • analyzer

      public final ExplainRequest.Builder analyzer​(@Nullable java.lang.String value)
      The analyzer for the query string query

      API name: analyzer

    • defaultOperator

      public final ExplainRequest.Builder defaultOperator​(@Nullable Operator value)
      The default operator for query string query (AND or OR)

      API name: default_operator

    • df

      public final ExplainRequest.Builder df​(@Nullable java.lang.String value)
      The default field for query string query (default: _all)

      API name: df

    • id

      public final ExplainRequest.Builder id​(java.lang.String value)
      Required - The document ID

      API name: id

    • index

      public final ExplainRequest.Builder index​(java.lang.String value)
      Required - The name of the index

      API name: index

    • lenient

      public final ExplainRequest.Builder lenient​(@Nullable java.lang.Boolean value)
      Specify whether format-based query failures (such as providing text to a numeric field) should be ignored

      API name: lenient

    • preference

      public final ExplainRequest.Builder preference​(@Nullable java.lang.String value)
      Specify the node or shard the operation should be performed on (default: random)

      API name: preference

    • q

      public final ExplainRequest.Builder q​(@Nullable java.lang.String value)
      Query in the Lucene query string syntax

      API name: q

    • query

      public final ExplainRequest.Builder query​(@Nullable Query value)
      API name: query

    • query

      public final ExplainRequest.Builder query​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      API name: query

    • routing

      public final ExplainRequest.Builder routing​(@Nullable java.lang.String value)
      Specific routing value

      API name: routing

    • storedFields

      public final ExplainRequest.Builder storedFields​(java.util.List<java.lang.String> list)
      A comma-separated list of stored fields to return in the response

      API name: stored_fields

      Adds all elements of list to storedFields.

    • storedFields

      public final ExplainRequest.Builder storedFields​(java.lang.String value, java.lang.String... values)
      A comma-separated list of stored fields to return in the response

      API name: stored_fields

      Adds one or more values to storedFields.

    • type

      public final ExplainRequest.Builder type​(@Nullable java.lang.String value)
      The type of the document

      API name: type

    • self

      protected ExplainRequest.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<ExplainRequest.Builder>

    • build

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