Class ExplainRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.core.ExplainRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<ExplainRequest>
- Enclosing class:
- ExplainRequest
public static class ExplainRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<ExplainRequest>
Builder for
ExplainRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ExplainRequest.Builder
analyzer(java.lang.String value)
The analyzer for the query string queryExplainRequest.Builder
analyzeWildcard(java.lang.Boolean value)
Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)ExplainRequest
build()
Builds aExplainRequest
.ExplainRequest.Builder
defaultOperator(Operator value)
The default operator for query string query (AND or OR)ExplainRequest.Builder
df(java.lang.String value)
The default field for query string query (default: _all)ExplainRequest.Builder
id(java.lang.String value)
Required - The document IDExplainRequest.Builder
index(java.lang.String value)
Required - The name of the indexExplainRequest.Builder
lenient(java.lang.Boolean value)
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredExplainRequest.Builder
preference(java.lang.String value)
Specify the node or shard the operation should be performed on (default: random)ExplainRequest.Builder
q(java.lang.String value)
Query in the Lucene query string syntaxExplainRequest.Builder
query(Query value)
API name:query
ExplainRequest.Builder
query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
API name:query
ExplainRequest.Builder
routing(java.lang.String value)
Specific routing valueExplainRequest.Builder
source(SourceConfigParam value)
True or false to return the _source field or not, or a list of fields to returnExplainRequest.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 returnExplainRequest.Builder
sourceExcludes(java.lang.String value, java.lang.String... values)
A list of fields to exclude from the returned _source fieldExplainRequest.Builder
sourceExcludes(java.util.List<java.lang.String> list)
A list of fields to exclude from the returned _source fieldExplainRequest.Builder
sourceIncludes(java.lang.String value, java.lang.String... values)
A list of fields to extract and return from the _source fieldExplainRequest.Builder
sourceIncludes(java.util.List<java.lang.String> list)
A list of fields to extract and return from the _source fieldExplainRequest.Builder
storedFields(java.lang.String value, java.lang.String... values)
A comma-separated list of stored fields to return in the responseExplainRequest.Builder
storedFields(java.util.List<java.lang.String> list)
A comma-separated list of stored fields to return in the responseExplainRequest.Builder
type(java.lang.String value)
The type of the documentMethods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
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(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 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
public final ExplainRequest.Builder sourceExcludes(java.lang.String value, java.lang.String... values)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
public final ExplainRequest.Builder sourceIncludes(java.lang.String value, java.lang.String... values)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
public final ExplainRequest.Builder query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)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
public final ExplainRequest.Builder storedFields(java.lang.String value, java.lang.String... values)A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
Adds one or more values to
storedFields
. -
type
The type of the documentAPI name:
type
-
build
Builds aExplainRequest
.- Specified by:
build
in interfaceObjectBuilder<ExplainRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-