org.elasticsearch.client.support

Class AbstractClient

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.client.support.AbstractClient

All Implemented Interfaces:

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

Direct Known Subclasses:

FilterClient, NodeClient, TransportClient

public abstract class AbstractClient
extends AbstractComponent
implements Client

Field Summary

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

Constructor and Description
AbstractClient(Settings settings, ThreadPool threadPool)

Method Summary

Modifier and Type	Method and Description
AdminClient	admin() The admin client that can be used to perform administrative operations.
ActionFuture<BulkResponse>	bulk(BulkRequest request) Executes a bulk of index / delete operations.
void	bulk(BulkRequest request, ActionListener<BulkResponse> listener) Executes a bulk of index / delete operations.
ActionFuture<ClearScrollResponse>	clearScroll(ClearScrollRequest request) Clears the search contexts associated with specified scroll ids.
void	clearScroll(ClearScrollRequest request, ActionListener<ClearScrollResponse> listener) Clears the search contexts associated with specified scroll ids.
ActionFuture<DeleteResponse>	delete(DeleteRequest request) Deletes a document from the index based on the index, type and id.
void	delete(DeleteRequest request, ActionListener<DeleteResponse> listener) Deletes a document from the index based on the index, type and id.
protected abstract <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void	doExecute(Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener)
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> ActionFuture<Response>	execute(Action<Request,Response,RequestBuilder> action, Request request) Executes a generic action, denoted by an Action.
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void	execute(Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener) This is the single execution point of *all* clients.
ActionFuture<ExplainResponse>	explain(ExplainRequest request) Computes a score explanation for the specified request.
void	explain(ExplainRequest request, ActionListener<ExplainResponse> listener) Computes a score explanation for the specified request.
ActionFuture<FieldCapabilitiesResponse>	fieldCaps(FieldCapabilitiesRequest request) An action that returns the field capabilities from the provided request
void	fieldCaps(FieldCapabilitiesRequest request, ActionListener<FieldCapabilitiesResponse> listener) An action that returns the field capabilities from the provided request
Client	filterWithHeader(java.util.Map<java.lang.String,java.lang.String> headers) Returns a new lightweight Client that applies all given headers to each of the requests issued from it.
ActionFuture<GetResponse>	get(GetRequest request) Gets the document that was indexed from an index with a type and id.
void	get(GetRequest request, ActionListener<GetResponse> listener) Gets the document that was indexed from an index with a type and id.
ActionFuture<IndexResponse>	index(IndexRequest request) Index a JSON source associated with a given index and type.
void	index(IndexRequest request, ActionListener<IndexResponse> listener) Index a document associated with a given index and type.
ActionFuture<MultiGetResponse>	multiGet(MultiGetRequest request) Multi get documents.
void	multiGet(MultiGetRequest request, ActionListener<MultiGetResponse> listener) Multi get documents.
ActionFuture<MultiSearchResponse>	multiSearch(MultiSearchRequest request) Performs multiple search requests.
void	multiSearch(MultiSearchRequest request, ActionListener<MultiSearchResponse> listener) Performs multiple search requests.
ActionFuture<MultiTermVectorsResponse>	multiTermVectors(MultiTermVectorsRequest request) Multi get term vectors.
void	multiTermVectors(MultiTermVectorsRequest request, ActionListener<MultiTermVectorsResponse> listener) Multi get term vectors.
BulkRequestBuilder	prepareBulk() Executes a bulk of index / delete operations.
ClearScrollRequestBuilder	prepareClearScroll() Clears the search contexts associated with specified scroll ids.
DeleteRequestBuilder	prepareDelete() Deletes a document from the index based on the index, type and id.
DeleteRequestBuilder	prepareDelete(java.lang.String index, java.lang.String type, java.lang.String id) Deletes a document from the index based on the index, type and id.
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> RequestBuilder	prepareExecute(Action<Request,Response,RequestBuilder> action) Prepares a request builder to execute, specified by Action.
ExplainRequestBuilder	prepareExplain(java.lang.String index, java.lang.String type, java.lang.String id) Computes a score explanation for the specified request.
FieldCapabilitiesRequestBuilder	prepareFieldCaps() Builder for the field capabilities request.
GetRequestBuilder	prepareGet() Gets the document that was indexed from an index with a type and id.
GetRequestBuilder	prepareGet(java.lang.String index, java.lang.String type, java.lang.String id) Gets the document that was indexed from an index with a type (optional) and id.
IndexRequestBuilder	prepareIndex() Index a document associated with a given index and type.
IndexRequestBuilder	prepareIndex(java.lang.String index, java.lang.String type) Index a document associated with a given index and type.
IndexRequestBuilder	prepareIndex(java.lang.String index, java.lang.String type, java.lang.String id) Index a document associated with a given index and type.
MultiGetRequestBuilder	prepareMultiGet() Multi get documents.
MultiSearchRequestBuilder	prepareMultiSearch() Performs multiple search requests.
MultiTermVectorsRequestBuilder	prepareMultiTermVectors() Multi get term vectors.
SearchRequestBuilder	prepareSearch(java.lang.String... indices) Search across one or more indices and one or more types with a query.
SearchScrollRequestBuilder	prepareSearchScroll(java.lang.String scrollId) A search scroll request to continue searching a previous scrollable search request.
TermVectorsRequestBuilder	prepareTermVector() Deprecated.
TermVectorsRequestBuilder	prepareTermVector(java.lang.String index, java.lang.String type, java.lang.String id) Deprecated.
TermVectorsRequestBuilder	prepareTermVectors() Builder for the term vector request.
TermVectorsRequestBuilder	prepareTermVectors(java.lang.String index, java.lang.String type, java.lang.String id) Builder for the term vector request.
UpdateRequestBuilder	prepareUpdate() Updates a document based on a script.
UpdateRequestBuilder	prepareUpdate(java.lang.String index, java.lang.String type, java.lang.String id) Updates a document based on a script.
ActionFuture<SearchResponse>	search(SearchRequest request) Search across one or more indices and one or more types with a query.
void	search(SearchRequest request, ActionListener<SearchResponse> listener) Search across one or more indices and one or more types with a query.
ActionFuture<SearchResponse>	searchScroll(SearchScrollRequest request) A search scroll request to continue searching a previous scrollable search request.
void	searchScroll(SearchScrollRequest request, ActionListener<SearchResponse> listener) A search scroll request to continue searching a previous scrollable search request.
Settings	settings() Returns this clients settings
ActionFuture<TermVectorsResponse>	termVector(TermVectorsRequest request) Deprecated.
void	termVector(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener) Deprecated.
ActionFuture<TermVectorsResponse>	termVectors(TermVectorsRequest request) An action that returns the term vectors for a specific document.
void	termVectors(TermVectorsRequest request, ActionListener<TermVectorsResponse> listener) An action that returns the term vectors for a specific document.
ThreadPool	threadPool() Returns the threadpool used to execute requests on this client
ActionFuture<UpdateResponse>	update(UpdateRequest request) Updates a document based on a script.
void	update(UpdateRequest request, ActionListener<UpdateResponse> listener) Updates a document based on a script.

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

Methods inherited from interface org.elasticsearch.common.lease.Releasable

close

Constructor Detail

AbstractClient

public AbstractClient(Settings settings,
                      ThreadPool threadPool)

Method Detail

settings

public final Settings settings()

Description copied from interface: Client

Returns this clients settings

Specified by:

settings in interface Client

threadPool

public final ThreadPool threadPool()

Description copied from interface: ElasticsearchClient

Returns the threadpool used to execute requests on this client

Specified by:

threadPool in interface ElasticsearchClient

admin

public final AdminClient admin()

Description copied from interface: Client

The admin client that can be used to perform administrative operations.

Specified by:

admin in interface Client

prepareExecute

public final <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> RequestBuilder prepareExecute(Action<Request,Response,RequestBuilder> action)

Description copied from interface: ElasticsearchClient

Prepares a request builder to execute, specified by Action.

Specified by:

prepareExecute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - The response type.

RequestBuilder - The request builder.

Parameters:

action - The action type to execute.

Returns:

The request builder, that can, at a later stage, execute the request.

execute

public final <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> ActionFuture<Response> execute(Action<Request,Response,RequestBuilder> action,
                                                                                                                                                                                         Request request)

Description copied from interface: ElasticsearchClient

Executes a generic action, denoted by an Action.

Specified by:

execute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - the response type.

RequestBuilder - The request builder type.

Parameters:

action - The action type to execute.

request - The action request.

Returns:

A future allowing to get back the response.

execute

public final <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> void execute(Action<Request,Response,RequestBuilder> action,
                                                                                                                                                                       Request request,
                                                                                                                                                                       ActionListener<Response> listener)

This is the single execution point of *all* clients.

Specified by:

execute in interface ElasticsearchClient

Type Parameters:

Request - The request type.

Response - The response type.

RequestBuilder - The request builder type.

Parameters:

action - The action type to execute.

request - The action request.

listener - The listener to receive the response back.

doExecute

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

index

public ActionFuture<IndexResponse> index(IndexRequest request)

Description copied from interface: Client

Index a JSON source associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

index in interface Client

Parameters:

request - The index request

Returns:

The result future

See Also:

Requests.indexRequest(String)

index

public void index(IndexRequest request,
                  ActionListener<IndexResponse> listener)

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

index in interface Client

Parameters:

request - The index request

listener - A listener to be notified with a result

See Also:

Requests.indexRequest(String)

prepareIndex

public IndexRequestBuilder prepareIndex()

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

prepareIndex in interface Client

prepareIndex

public IndexRequestBuilder prepareIndex(java.lang.String index,
                                        java.lang.String type)

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

prepareIndex in interface Client

Parameters:

index - The index to index the document to

type - The type to index the document to

prepareIndex

public IndexRequestBuilder prepareIndex(java.lang.String index,
                                        java.lang.String type,
                                        @Nullable
                                        java.lang.String id)

Description copied from interface: Client

Index a document associated with a given index and type.

The id is optional, if it is not provided, one will be generated automatically.

Specified by:

prepareIndex in interface Client

Parameters:

index - The index to index the document to

type - The type to index the document to

id - The id of the document

update

public ActionFuture<UpdateResponse> update(UpdateRequest request)

Description copied from interface: Client

Updates a document based on a script.

Specified by:

update in interface Client

Parameters:

request - The update request

Returns:

The result future

update

public void update(UpdateRequest request,
                   ActionListener<UpdateResponse> listener)

Description copied from interface: Client

Updates a document based on a script.

Specified by:

update in interface Client

Parameters:

request - The update request

listener - A listener to be notified with a result

prepareUpdate

public UpdateRequestBuilder prepareUpdate()

Description copied from interface: Client

Updates a document based on a script.

Specified by:

prepareUpdate in interface Client

prepareUpdate

public UpdateRequestBuilder prepareUpdate(java.lang.String index,
                                          java.lang.String type,
                                          java.lang.String id)

Description copied from interface: Client

Updates a document based on a script.

Specified by:

prepareUpdate in interface Client

delete

public ActionFuture<DeleteResponse> delete(DeleteRequest request)

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

delete in interface Client

Parameters:

request - The delete request

Returns:

The result future

See Also:

Requests.deleteRequest(String)

delete

public void delete(DeleteRequest request,
                   ActionListener<DeleteResponse> listener)

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

delete in interface Client

Parameters:

request - The delete request

listener - A listener to be notified with a result

See Also:

Requests.deleteRequest(String)

prepareDelete

public DeleteRequestBuilder prepareDelete()

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

prepareDelete in interface Client

prepareDelete

public DeleteRequestBuilder prepareDelete(java.lang.String index,
                                          java.lang.String type,
                                          java.lang.String id)

Description copied from interface: Client

Deletes a document from the index based on the index, type and id.

Specified by:

prepareDelete in interface Client

Parameters:

index - The index to delete the document from

type - The type of the document to delete

id - The id of the document to delete

bulk

public ActionFuture<BulkResponse> bulk(BulkRequest request)

Description copied from interface: Client

Executes a bulk of index / delete operations.

Specified by:

bulk in interface Client

Parameters:

request - The bulk request

Returns:

The result future

See Also:

Requests.bulkRequest()

bulk

public void bulk(BulkRequest request,
                 ActionListener<BulkResponse> listener)

Description copied from interface: Client

Executes a bulk of index / delete operations.

Specified by:

bulk in interface Client

Parameters:

request - The bulk request

listener - A listener to be notified with a result

See Also:

Requests.bulkRequest()

prepareBulk

public BulkRequestBuilder prepareBulk()

Description copied from interface: Client

Executes a bulk of index / delete operations.

Specified by:

prepareBulk in interface Client

get

public ActionFuture<GetResponse> get(GetRequest request)

Description copied from interface: Client

Gets the document that was indexed from an index with a type and id.

Specified by:

get in interface Client

Parameters:

request - The get request

Returns:

The result future

See Also:

Requests.getRequest(String)

get

public void get(GetRequest request,
                ActionListener<GetResponse> listener)

Description copied from interface: Client

Gets the document that was indexed from an index with a type and id.

Specified by:

get in interface Client

Parameters:

request - The get request

listener - A listener to be notified with a result

See Also:

Requests.getRequest(String)

prepareGet

public GetRequestBuilder prepareGet()

Description copied from interface: Client

Gets the document that was indexed from an index with a type and id.

Specified by:

prepareGet in interface Client

prepareGet

public GetRequestBuilder prepareGet(java.lang.String index,
                                    java.lang.String type,
                                    java.lang.String id)

Description copied from interface: Client

Gets the document that was indexed from an index with a type (optional) and id.

Specified by:

prepareGet in interface Client

multiGet

public ActionFuture<MultiGetResponse> multiGet(MultiGetRequest request)

Description copied from interface: Client

Multi get documents.

Specified by:

multiGet in interface Client

multiGet

public void multiGet(MultiGetRequest request,
                     ActionListener<MultiGetResponse> listener)

Description copied from interface: Client

Multi get documents.

Specified by:

multiGet in interface Client

prepareMultiGet

public MultiGetRequestBuilder prepareMultiGet()

Description copied from interface: Client

Multi get documents.

Specified by:

prepareMultiGet in interface Client

search

public ActionFuture<SearchResponse> search(SearchRequest request)

Description copied from interface: Client

Search across one or more indices and one or more types with a query.

Specified by:

search in interface Client

Parameters:

request - The search request

Returns:

The result future

See Also:

Requests.searchRequest(String...)

search

public void search(SearchRequest request,
                   ActionListener<SearchResponse> listener)

Description copied from interface: Client

Search across one or more indices and one or more types with a query.

Specified by:

search in interface Client

Parameters:

request - The search request

listener - A listener to be notified of the result

See Also:

Requests.searchRequest(String...)

prepareSearch

public SearchRequestBuilder prepareSearch(java.lang.String... indices)

Description copied from interface: Client

Search across one or more indices and one or more types with a query.

Specified by:

prepareSearch in interface Client

searchScroll

public ActionFuture<SearchResponse> searchScroll(SearchScrollRequest request)

Description copied from interface: Client

A search scroll request to continue searching a previous scrollable search request.

Specified by:

searchScroll in interface Client

Parameters:

request - The search scroll request

Returns:

The result future

See Also:

Requests.searchScrollRequest(String)

searchScroll

public void searchScroll(SearchScrollRequest request,
                         ActionListener<SearchResponse> listener)

Description copied from interface: Client

A search scroll request to continue searching a previous scrollable search request.

Specified by:

searchScroll in interface Client

Parameters:

request - The search scroll request

listener - A listener to be notified of the result

See Also:

Requests.searchScrollRequest(String)

prepareSearchScroll

public SearchScrollRequestBuilder prepareSearchScroll(java.lang.String scrollId)

Description copied from interface: Client

A search scroll request to continue searching a previous scrollable search request.

Specified by:

prepareSearchScroll in interface Client

multiSearch

public ActionFuture<MultiSearchResponse> multiSearch(MultiSearchRequest request)

Description copied from interface: Client

Performs multiple search requests.

Specified by:

multiSearch in interface Client

multiSearch

public void multiSearch(MultiSearchRequest request,
                        ActionListener<MultiSearchResponse> listener)

Description copied from interface: Client

Performs multiple search requests.

Specified by:

multiSearch in interface Client

prepareMultiSearch

public MultiSearchRequestBuilder prepareMultiSearch()

Description copied from interface: Client

Performs multiple search requests.

Specified by:

prepareMultiSearch in interface Client

termVectors

public ActionFuture<TermVectorsResponse> termVectors(TermVectorsRequest request)

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVectors in interface Client

Parameters:

request - The term vector request

Returns:

The response future

termVectors

public void termVectors(TermVectorsRequest request,
                        ActionListener<TermVectorsResponse> listener)

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVectors in interface Client

Parameters:

request - The term vector request

prepareTermVectors

public TermVectorsRequestBuilder prepareTermVectors()

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVectors in interface Client

prepareTermVectors

public TermVectorsRequestBuilder prepareTermVectors(java.lang.String index,
                                                    java.lang.String type,
                                                    java.lang.String id)

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVectors in interface Client

Parameters:

index - The index to load the document from

type - The type of the document

id - The id of the document

termVector

@Deprecated
public ActionFuture<TermVectorsResponse> termVector(TermVectorsRequest request)

Deprecated.

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVector in interface Client

Parameters:

request - The term vector request

Returns:

The response future

termVector

@Deprecated
public void termVector(TermVectorsRequest request,
                                   ActionListener<TermVectorsResponse> listener)

Deprecated.

Description copied from interface: Client

An action that returns the term vectors for a specific document.

Specified by:

termVector in interface Client

Parameters:

request - The term vector request

prepareTermVector

@Deprecated
public TermVectorsRequestBuilder prepareTermVector()

Deprecated.

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVector in interface Client

prepareTermVector

@Deprecated
public TermVectorsRequestBuilder prepareTermVector(java.lang.String index,
                                                               java.lang.String type,
                                                               java.lang.String id)

Deprecated.

Description copied from interface: Client

Builder for the term vector request.

Specified by:

prepareTermVector in interface Client

Parameters:

index - The index to load the document from

type - The type of the document

id - The id of the document

multiTermVectors

public ActionFuture<MultiTermVectorsResponse> multiTermVectors(MultiTermVectorsRequest request)

Description copied from interface: Client

Multi get term vectors.

Specified by:

multiTermVectors in interface Client

multiTermVectors

public void multiTermVectors(MultiTermVectorsRequest request,
                             ActionListener<MultiTermVectorsResponse> listener)

Description copied from interface: Client

Multi get term vectors.

Specified by:

multiTermVectors in interface Client

prepareMultiTermVectors

public MultiTermVectorsRequestBuilder prepareMultiTermVectors()

Description copied from interface: Client

Multi get term vectors.

Specified by:

prepareMultiTermVectors in interface Client

prepareExplain

public ExplainRequestBuilder prepareExplain(java.lang.String index,
                                            java.lang.String type,
                                            java.lang.String id)

Description copied from interface: Client

Computes a score explanation for the specified request.

Specified by:

prepareExplain in interface Client

Parameters:

index - The index this explain is targeted for

type - The type this explain is targeted for

id - The document identifier this explain is targeted for

explain

public ActionFuture<ExplainResponse> explain(ExplainRequest request)

Description copied from interface: Client

Computes a score explanation for the specified request.

Specified by:

explain in interface Client

Parameters:

request - The request encapsulating the query and document identifier to compute a score explanation for

explain

public void explain(ExplainRequest request,
                    ActionListener<ExplainResponse> listener)

Description copied from interface: Client

Computes a score explanation for the specified request.

Specified by:

explain in interface Client

Parameters:

request - The request encapsulating the query and document identifier to compute a score explanation for

listener - A listener to be notified of the result

clearScroll

public void clearScroll(ClearScrollRequest request,
                        ActionListener<ClearScrollResponse> listener)

Description copied from interface: Client

Clears the search contexts associated with specified scroll ids.

Specified by:

clearScroll in interface Client

clearScroll

public ActionFuture<ClearScrollResponse> clearScroll(ClearScrollRequest request)

Description copied from interface: Client

Clears the search contexts associated with specified scroll ids.

Specified by:

clearScroll in interface Client

prepareClearScroll

public ClearScrollRequestBuilder prepareClearScroll()

Description copied from interface: Client

Clears the search contexts associated with specified scroll ids.

Specified by:

prepareClearScroll in interface Client

fieldCaps

public void fieldCaps(FieldCapabilitiesRequest request,
                      ActionListener<FieldCapabilitiesResponse> listener)

Description copied from interface: Client

An action that returns the field capabilities from the provided request

Specified by:

fieldCaps in interface Client

fieldCaps

public ActionFuture<FieldCapabilitiesResponse> fieldCaps(FieldCapabilitiesRequest request)

Description copied from interface: Client

An action that returns the field capabilities from the provided request

Specified by:

fieldCaps in interface Client

prepareFieldCaps

public FieldCapabilitiesRequestBuilder prepareFieldCaps()

Description copied from interface: Client

Builder for the field capabilities request.

Specified by:

prepareFieldCaps in interface Client

filterWithHeader

public Client filterWithHeader(java.util.Map<java.lang.String,java.lang.String> headers)

Description copied from interface: Client

Returns a new lightweight Client that applies all given headers to each of the requests issued from it.

Specified by:

filterWithHeader in interface Client