Package co.elastic.clients.elasticsearch.core

Class ExplainRequest.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<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 RequestBase.AbstractBuilder<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(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(List<String> list)
      A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_excludes

      Adds all elements of list to sourceExcludes.

    • sourceExcludes

      public final ExplainRequest.Builder sourceExcludes(String value, String... values)
      A comma-separated list of source fields to exclude from the response. You can also use this parameter to exclude fields from the subset specified in _source_includes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_excludes

      Adds one or more values to sourceExcludes.

    • sourceIncludes

      public final ExplainRequest.Builder sourceIncludes(List<String> list)
      A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_includes

      Adds all elements of list to sourceIncludes.

    • sourceIncludes

      public final ExplainRequest.Builder sourceIncludes(String value, String... values)
      A comma-separated list of source fields to include in the response. If this parameter is specified, only these source fields are returned. You can exclude fields from this subset using the _source_excludes query parameter. If the _source parameter is false, this parameter is ignored.

      API name: _source_includes

      Adds one or more values to sourceIncludes.

    • analyzeWildcard

      public final ExplainRequest.Builder analyzeWildcard(@Nullable Boolean value)
      If true, wildcard and prefix queries are analyzed. This parameter can be used only when the q query string parameter is specified.

      API name: analyze_wildcard

    • analyzer

      public final ExplainRequest.Builder analyzer(@Nullable String value)
      The analyzer to use for the query string. This parameter can be used only when the q query string parameter is specified.

      API name: analyzer

    • defaultOperator

      public final ExplainRequest.Builder defaultOperator(@Nullable Operator value)
      The default operator for query string query: and or or. This parameter can be used only when the q query string parameter is specified.

      API name: default_operator

    • df

      public final ExplainRequest.Builder df(@Nullable String value)
      The field to use as default where no field prefix is given in the query string. This parameter can be used only when the q query string parameter is specified.

      API name: df

    • id

      public final ExplainRequest.Builder id(String value)
      Required - The document identifier.

      API name: id

    • index

      public final ExplainRequest.Builder index(String value)
      Required - Index names that are used to limit the request. Only a single index name can be provided to this parameter.

      API name: index

    • lenient

      public final ExplainRequest.Builder lenient(@Nullable Boolean value)
      If true, format-based query failures (such as providing text to a numeric field) in the query string will be ignored. This parameter can be used only when the q query string parameter is specified.

      API name: lenient

    • preference

      public final ExplainRequest.Builder preference(@Nullable String value)
      The node or shard the operation should be performed on. It is random by default.

      API name: preference

    • q

      public final ExplainRequest.Builder q(@Nullable String value)
      The query in the Lucene query string syntax.

      API name: q

    • query

      public final ExplainRequest.Builder query(@Nullable Query value)
      Defines the search definition using the Query DSL.

      API name: query

    • query

      public final ExplainRequest.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)
      Defines the search definition using the Query DSL.

      API name: query

    • query

      public final ExplainRequest.Builder query(QueryVariant value)
      Defines the search definition using the Query DSL.

      API name: query

    • routing

      public final ExplainRequest.Builder routing(@Nullable String value)
      A custom value used to route operations to a specific shard.

      API name: routing

    • storedFields

      public final ExplainRequest.Builder storedFields(List<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(String value, 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.

    • self

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

    • build

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