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 Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal ExplainRequest.Builder
Analyzer to use for the query string.final ExplainRequest.Builder
analyzeWildcard
(Boolean value) Iftrue
, wildcard and prefix queries are analyzed.build()
Builds aExplainRequest
.final ExplainRequest.Builder
defaultOperator
(Operator value) The default operator for query string query:AND
orOR
.final ExplainRequest.Builder
Field to use as default where no field prefix is given in the query string.final ExplainRequest.Builder
Required - Defines the document ID.final ExplainRequest.Builder
Required - Index names used to limit the request.final ExplainRequest.Builder
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.final ExplainRequest.Builder
preference
(String value) Specifies the node or shard the operation should be performed on.final ExplainRequest.Builder
Query in the Lucene query string syntax.final ExplainRequest.Builder
Defines the search definition using the Query DSL.final ExplainRequest.Builder
Defines the search definition using the Query DSL.final ExplainRequest.Builder
Custom value used to route operations to a specific shard.protected ExplainRequest.Builder
self()
final ExplainRequest.Builder
source
(SourceConfigParam value) True or false to return the_source
field or not, or a list of fields to return.final ExplainRequest.Builder
True or false to return the_source
field or not, or a list of fields to return.final ExplainRequest.Builder
sourceExcludes
(String value, String... values) A comma-separated list of source fields to exclude from the response.final ExplainRequest.Builder
sourceExcludes
(List<String> list) A comma-separated list of source fields to exclude from the response.final ExplainRequest.Builder
sourceIncludes
(String value, String... values) A comma-separated list of source fields to include in the response.final ExplainRequest.Builder
sourceIncludes
(List<String> list) A comma-separated list of source fields to include in the response.final ExplainRequest.Builder
storedFields
(String value, String... values) A comma-separated list of stored fields to return in the response.final ExplainRequest.Builder
storedFields
(List<String> list) A comma-separated list of stored fields to return in the response.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
source
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
A comma-separated list of source fields to exclude from the response.API name:
_source_excludes
Adds all elements of
list
tosourceExcludes
. -
sourceExcludes
A comma-separated list of source fields to exclude from the response.API name:
_source_excludes
Adds one or more values to
sourceExcludes
. -
sourceIncludes
A comma-separated list of source fields to include in the response.API name:
_source_includes
Adds all elements of
list
tosourceIncludes
. -
sourceIncludes
A comma-separated list of source fields to include in the response.API name:
_source_includes
Adds one or more values to
sourceIncludes
. -
analyzeWildcard
Iftrue
, wildcard and prefix queries are analyzed.API name:
analyze_wildcard
-
analyzer
Analyzer to use for the query string. This parameter can only be used when theq
query string parameter is specified.API name:
analyzer
-
defaultOperator
The default operator for query string query:AND
orOR
.API name:
default_operator
-
df
Field to use as default where no field prefix is given in the query string.API name:
df
-
id
Required - Defines the document ID.API name:
id
-
index
Required - Index names used to limit the request. Only a single index name can be provided to this parameter.API name:
index
-
lenient
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.API name:
lenient
-
preference
Specifies the node or shard the operation should be performed on. Random by default.API name:
preference
-
q
Query in the Lucene query string syntax.API name:
q
-
query
Defines the search definition using the Query DSL.API name:
query
-
query
Defines the search definition using the Query DSL.API name:
query
-
routing
Custom value used to route operations to a specific shard.API name:
routing
-
storedFields
A comma-separated list of stored fields to return in the response.API name:
stored_fields
Adds all elements of
list
tostoredFields
. -
storedFields
A comma-separated list of stored fields to return in the response.API name:
stored_fields
Adds one or more values to
storedFields
. -
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ExplainRequest.Builder>
-
build
Builds aExplainRequest
.- Specified by:
build
in interfaceObjectBuilder<ExplainRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-