Class ExplainRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.core.ExplainRequest
- All Implemented Interfaces:
JsonpSerializable
Returns information about why a specific matches (or doesn't match) a query.
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<ExplainRequest>
Json deserializer forExplainRequest
static final SimpleEndpoint<ExplainRequest,
?> Endpoint "explain
". -
Method Summary
Modifier and TypeMethodDescriptionfinal String
analyzer()
The analyzer for the query string queryfinal Boolean
Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false)static <TDocument>
Endpoint<ExplainRequest,ExplainResponse<TDocument>, ErrorResponse> createExplainEndpoint
(JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "explain
" endpoint.final Operator
The default operator for query string query (AND or OR)final String
df()
The default field for query string query (default: _all)final String
id()
Required - The document IDfinal String
index()
Required - The name of the indexfinal Boolean
lenient()
Specify whether format-based query failures (such as providing text to a numeric field) should be ignoredstatic ExplainRequest
final String
Specify the node or shard the operation should be performed on (default: random)final String
q()
Query in the Lucene query string syntaxfinal Query
query()
API name:query
final String
routing()
Specific routing valuevoid
serialize
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) Serialize this object to JSON.protected void
serializeInternal
(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper) protected static void
final SourceConfigParam
source()
True or false to return the _source field or not, or a list of fields to returnA list of fields to exclude from the returned _source fieldA list of fields to extract and return from the _source fieldA comma-separated list of stored fields to return in the responseMethods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forExplainRequest
-
_ENDPOINT
Endpoint "explain
".
-
-
Method Details
-
of
-
source
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
-
sourceIncludes
A list of fields to extract and return from the _source fieldAPI name:
_source_includes
-
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
-
routing
Specific routing valueAPI name:
routing
-
storedFields
A comma-separated list of stored fields to return in the responseAPI name:
stored_fields
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupExplainRequestDeserializer
protected static void setupExplainRequestDeserializer(ObjectDeserializer<ExplainRequest.Builder> op) -
createExplainEndpoint
public static <TDocument> Endpoint<ExplainRequest,ExplainResponse<TDocument>, createExplainEndpointErrorResponse> (JsonpDeserializer<TDocument> tDocumentDeserializer) Create an "explain
" endpoint.
-