org.elasticsearch.action.explain

Class ExplainRequestBuilder

java.lang.Object

org.elasticsearch.action.ActionRequestBuilder<Request,Response,RequestBuilder>

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

Constructors

Constructor and Description
ExplainRequestBuilder(ElasticsearchClient client, ExplainAction action, String index, String type, String id)

Method Summary

Methods

Modifier and Type	Method and Description
protected ExplainRequest	beforeExecute(ExplainRequest request) A callback to additionally process the request before its executed
ExplainRequestBuilder	setFetchSource(boolean fetch) Indicates whether the response should contain the stored _source
ExplainRequestBuilder	setFetchSource(String[] includes, String[] excludes) Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.
ExplainRequestBuilder	setFetchSource(String include, String exclude) Indicate that _source should be returned, with an "include" and/or "exclude" set which can include simple wildcard elements.
ExplainRequestBuilder	setFields(String... fields) Explicitly specify the fields that will be returned for the explained document.
ExplainRequestBuilder	setId(String id) Sets the id to get a score explanation for.
ExplainRequestBuilder	setParent(String parent) Simple sets the routing.
ExplainRequestBuilder	setPreference(String preference) Sets the shard preference.
ExplainRequestBuilder	setQuery(BytesReference query) Sets the query to get a score explanation for.
ExplainRequestBuilder	setQuery(QueryBuilder query) Sets the query to get a score explanation for.
ExplainRequestBuilder	setRouting(String routing) Sets the routing for sharding.
ExplainRequestBuilder	setSource(BytesReference source) Sets the full source of the explain request (for example, wrapping an actual query).
ExplainRequestBuilder	setType(String type) Sets the type to get a score explanation for.

Methods inherited from class org.elasticsearch.action.support.single.shard.SingleShardOperationRequestBuilder

setIndex, setOperationThreaded

Methods inherited from class org.elasticsearch.action.ActionRequestBuilder

execute, execute, get, get, get, putHeader, request

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExplainRequestBuilder

public ExplainRequestBuilder(ElasticsearchClient client,
                     ExplainAction action,
                     String index,
                     String type,
                     String id)

Method Detail

setType

public ExplainRequestBuilder setType(String type)

Sets the type to get a score explanation for.

setId

public ExplainRequestBuilder setId(String id)

Sets the id to get a score explanation for.

setRouting

public ExplainRequestBuilder setRouting(String routing)

Sets the routing for sharding.

setParent

public ExplainRequestBuilder setParent(String parent)

Simple sets the routing. Since the parent is only used to get to the right shard.

setPreference

public ExplainRequestBuilder setPreference(String preference)

Sets the shard preference.

setQuery

public ExplainRequestBuilder setQuery(QueryBuilder query)

Sets the query to get a score explanation for.

setQuery

public ExplainRequestBuilder setQuery(BytesReference query)

Sets the query to get a score explanation for.

setFields

public ExplainRequestBuilder setFields(String... fields)

Explicitly specify the fields that will be returned for the explained document. By default, nothing is returned.

setFetchSource

public ExplainRequestBuilder setFetchSource(boolean fetch)

Indicates whether the response should contain the stored _source

setFetchSource

public ExplainRequestBuilder setFetchSource(@Nullable
                                   String include,
                                   @Nullable
                                   String exclude)

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 _source

exclude - An optional exclude (optionally wildcarded) pattern to filter the returned _source

setFetchSource

public ExplainRequestBuilder setFetchSource(@Nullable
                                   String[] includes,
                                   @Nullable
                                   String[] excludes)

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 _source

excludes - An optional list of exclude (optionally wildcarded) pattern to filter the returned _source

setSource

public ExplainRequestBuilder setSource(BytesReference source)

Sets the full source of the explain request (for example, wrapping an actual query).

beforeExecute

protected ExplainRequest beforeExecute(ExplainRequest request)

Description copied from class: ActionRequestBuilder

A callback to additionally process the request before its executed

Overrides:

beforeExecute in class ActionRequestBuilder<ExplainRequest,ExplainResponse,ExplainRequestBuilder>

Parameters:

request - Request