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 document 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()
Analyzer to use for the query string.final Boolean
Iftrue
, wildcard and prefix queries are analyzed.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
orOR
.final String
df()
Field to use as default where no field prefix is given in the query string.final String
id()
Required - Defines the document ID.final String
index()
Required - Index names used to limit the request.final Boolean
lenient()
Iftrue
, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.static ExplainRequest
final String
Specifies the node or shard the operation should be performed on.final String
q()
Query in the Lucene query string syntax.final Query
query()
Defines the search definition using the Query DSL.final String
routing()
Custom value used to route operations to a specific shard.void
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 return.A comma-separated list of source fields to exclude from the response.A comma-separated list of source fields to include in the response.A comma-separated list of stored fields to return in the response.Methods 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 return.API name:
_source
-
sourceExcludes
A comma-separated list of source fields to exclude from the response.API name:
_source_excludes
-
sourceIncludes
A comma-separated list of source fields to include in the response.API name:
_source_includes
-
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
-
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
-
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.
-