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
The analyzer for the query string queryfinal ExplainRequest.Builder
analyzeWildcard
(Boolean value) Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)build()
Builds aExplainRequest
.final ExplainRequest.Builder
defaultOperator
(Operator value) The default operator for query string query (AND or OR)final ExplainRequest.Builder
The default field for query string query (default: _all)final ExplainRequest.Builder
Required - The document IDfinal ExplainRequest.Builder
Required - The name of the indexfinal ExplainRequest.Builder
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredfinal ExplainRequest.Builder
preference
(String value) Specify the node or shard the operation should be performed on (default: random)final ExplainRequest.Builder
Query in the Lucene query string syntaxfinal ExplainRequest.Builder
API name:query
final ExplainRequest.Builder
API name:query
final ExplainRequest.Builder
Specific routing valueprotected 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 returnfinal ExplainRequest.Builder
True or false to return the _source field or not, or a list of fields to returnfinal ExplainRequest.Builder
sourceExcludes
(String value, String... values) A list of fields to exclude from the returned _source fieldfinal ExplainRequest.Builder
sourceExcludes
(List<String> list) A list of fields to exclude from the returned _source fieldfinal ExplainRequest.Builder
sourceIncludes
(String value, String... values) A list of fields to extract and return from the _source fieldfinal ExplainRequest.Builder
sourceIncludes
(List<String> list) A list of fields to extract and return from the _source fieldfinal ExplainRequest.Builder
storedFields
(String value, String... values) A comma-separated list of stored fields to return in the responsefinal ExplainRequest.Builder
storedFields
(List<String> list) A comma-separated list of stored fields to return in the responseMethods 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 returnAPI 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 returnAPI name:
_source
-
sourceExcludes
A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
Adds all elements of
list
tosourceExcludes
. -
sourceExcludes
A list of fields to exclude from the returned _source fieldAPI name:
_source_excludes
Adds one or more values to
sourceExcludes
. -
sourceIncludes
A list of fields to extract and return from the _source fieldAPI name:
_source_includes
Adds all elements of
list
tosourceIncludes
. -
sourceIncludes
A list of fields to extract and return from the _source fieldAPI name:
_source_includes
Adds one or more values to
sourceIncludes
. -
analyzeWildcard
Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)API name:
analyze_wildcard
-
analyzer
The analyzer for the query string queryAPI name:
analyzer
-
defaultOperator
The default operator for query string query (AND or OR)API name:
default_operator
-
df
The default field for query string query (default: _all)API name:
df
-
id
Required - The document IDAPI name:
id
-
index
Required - The name of the indexAPI name:
index
-
lenient
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredAPI name:
lenient
-
preference
Specify the node or shard the operation should be performed on (default: random)API name:
preference
-
q
Query in the Lucene query string syntaxAPI name:
q
-
query
API name:query
-
query
API name:query
-
routing
Specific routing valueAPI name:
routing
-
storedFields
A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
Adds all elements of
list
tostoredFields
. -
storedFields
A comma-separated list of stored fields to return in the responseAPI 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.
-