Package co.elastic.clients.elasticsearch._core

Class ExplainRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch._core.ExplainRequest.Builder
All Implemented Interfaces:
ObjectBuilder<ExplainRequest>
Enclosing class:
ExplainRequest
public static class ExplainRequest.Builder
extends java.lang.Object
implements ObjectBuilder<ExplainRequest>
Builder for ExplainRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • id

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

      API name: id

    • index

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

      API name: index

    • type

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

      API name: type

    • analyzer

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

      API name: analyzer

    • analyzeWildcard

      public 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

    • defaultOperator

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

      API name: default_operator

    • df

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

      API name: df

    • lenient

      public 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 ExplainRequest.Builder preference​(@Nullable java.lang.String value)
      Specify the node or shard the operation should be performed on (default: random)

      API name: preference

    • routing

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

      API name: routing

    • source

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

      API name: _source

    • sourceExcludes

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

      API name: _source_excludes

    • sourceExcludes

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

      API name: _source_excludes

    • addSourceExcludes

      public ExplainRequest.Builder addSourceExcludes​(java.lang.String value)
      Add a value to sourceExcludes(List), creating the list if needed.

    • sourceIncludes

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

      API name: _source_includes

    • sourceIncludes

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

      API name: _source_includes

    • addSourceIncludes

      public ExplainRequest.Builder addSourceIncludes​(java.lang.String value)
      Add a value to sourceIncludes(List), creating the list if needed.

    • storedFields

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

      API name: stored_fields

    • storedFields

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

      API name: stored_fields

    • addStoredFields

      public ExplainRequest.Builder addStoredFields​(java.lang.String value)
      Add a value to storedFields(List), creating the list if needed.

    • q

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

      API name: q

    • query

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

    • query

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

    • 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.