Package org.elasticsearch.action.explain
Class ExplainRequestBuilder
org.elasticsearch.action.ActionRequestBuilder<Request,Response>
org.elasticsearch.action.support.single.shard.SingleShardOperationRequestBuilder<ExplainRequest,ExplainResponse,ExplainRequestBuilder>
org.elasticsearch.action.explain.ExplainRequestBuilder
public class ExplainRequestBuilder
extends SingleShardOperationRequestBuilder<ExplainRequest,ExplainResponse,ExplainRequestBuilder>
A builder for
ExplainRequest
.-
Field Summary
Fields inherited from class org.elasticsearch.action.ActionRequestBuilder
action, client, request
-
Constructor Summary
ConstructorDescriptionExplainRequestBuilder(ElasticsearchClient client, ExplainAction action, index, type, id)
-
Method Summary
Modifier and TypeMethodDescriptionsetFetchSource(boolean fetch)
Indicates whether the response should contain the stored _source[] includes, [] excludes)
Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.include, exclude)
Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.id)
Sets the id to get a score explanation for.parent)
Simple sets the routing.preference)
Sets the shard preference.setQuery(QueryBuilder query)
Sets the query to get a score explanation for.routing)
Sets the routing for sharding.... fields)
Explicitly specify the stored fields that will be returned for the explained document.type)
Sets the type to get a score explanation for.Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardOperationRequestBuilder
setIndex
Methods inherited from class org.elasticsearch.action.ActionRequestBuilder
execute, execute, get, get, get, request
Methods inherited from class java.lang.
, , , , , , , , , ,
-
Constructor Details
-
ExplainRequestBuilder
-
-
Method Details
-
setType
public type)Sets the type to get a score explanation for. -
setId
public id)Sets the id to get a score explanation for. -
setRouting
public routing)Sets the routing for sharding. -
setParent
public parent)Simple sets the routing. Since the parent is only used to get to the right shard. -
setPreference
public preference)Sets the shard preference. -
setQuery
Sets the query to get a score explanation for. -
setStoredFields
public ... fields)Explicitly specify the stored fields that will be returned for the explained document. By default, nothing is returned. -
setFetchSource
Indicates whether the response should contain the stored _source -
setFetchSource
Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.- Parameters:
include
- An optional include (optionally wildcarded) pattern to filter the returned _sourceexclude
- An optional exclude (optionally wildcarded) pattern to filter the returned _source
-
setFetchSource
Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.- Parameters:
includes
- An optional list of include (optionally wildcarded) pattern to filter the returned _sourceexcludes
- An optional list of exclude (optionally wildcarded) pattern to filter the returned _source
-