Package org.elasticsearch.client

Class FilterClient

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.client.support.AbstractClient

org.elasticsearch.client.FilterClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Client, ElasticsearchClient, Releasable

Direct Known Subclasses:

ParentTaskAssigningClient

public abstract class FilterClient
extends AbstractClient

A Client that contains another Client which it uses as its basic source, possibly transforming the requests / responses along the way or providing additional functionality.

Field Summary

Fields

Modifier and Type	Field	Description
protected Client	in

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Fields inherited from interface org.elasticsearch.client.Client

CLIENT_TYPE_SETTING_S

Constructor Summary

Constructors

Modifier	Constructor	Description
	FilterClient(Client in)	Creates a new FilterClient
protected	FilterClient(Settings settings, ThreadPool threadPool, Client in)	A Constructor that allows to pass settings and threadpool separately.

Method Summary

Modifier and Type	Method	Description
void	close()
protected <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void	doExecute(Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener)
Client	getRemoteClusterClient(java.lang.String clusterAlias)	Returns a client to a remote cluster with the given cluster alias.
protected Client	in()	Returns the delegate Client

Methods inherited from class org.elasticsearch.client.support.AbstractClient

admin, bulk, bulk, clearScroll, clearScroll, delete, delete, execute, execute, explain, explain, fieldCaps, fieldCaps, filterWithHeader, get, get, index, index, multiGet, multiGet, multiSearch, multiSearch, multiTermVectors, multiTermVectors, prepareBulk, prepareClearScroll, prepareDelete, prepareDelete, prepareExecute, prepareExplain, prepareFieldCaps, prepareGet, prepareGet, prepareIndex, prepareIndex, prepareIndex, prepareMultiGet, prepareMultiSearch, prepareMultiTermVectors, prepareSearch, prepareSearchScroll, prepareTermVector, prepareTermVector, prepareTermVectors, prepareTermVectors, prepareUpdate, prepareUpdate, search, search, searchScroll, searchScroll, settings, termVector, termVector, termVectors, termVectors, threadPool, update, update

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from class java.lang.Object

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

Field Detail

in

protected final Client in

Constructor Detail

FilterClient

public FilterClient(Client in)

Creates a new FilterClient

Parameters:

in - the client to delegate to

See Also:

in()

FilterClient

protected FilterClient(Settings settings,
                       ThreadPool threadPool,
                       Client in)

A Constructor that allows to pass settings and threadpool separately. This is useful if the client is a proxy and not yet fully constructed ie. both dependencies are not available yet.

Method Detail

close

public void close()

doExecute

protected <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void doExecute(Action<Request,Response,RequestBuilder> action,
                                                                                                                                                                      Request request,
                                                                                                                                                                      ActionListener<Response> listener)

Specified by:

doExecute in class AbstractClient

in

protected Client in()

Returns the delegate Client

getRemoteClusterClient

public Client getRemoteClusterClient(java.lang.String clusterAlias)

Description copied from interface: Client

Returns a client to a remote cluster with the given cluster alias.