org.elasticsearch.client
Interface Client

All Known Subinterfaces:

InternalClient

All Known Implementing Classes:

AbstractClient, InternalTransportClient, NodeClient, TransportClient

public interface Client

A client provides a one stop interface for performing actions/operations against the cluster.

All operations performed are asynchronous by nature. Each action/operation has two flavors, the first simply returns an ActionFuture, while the second accepts an ActionListener.

A client can either be retrieved from a Node started, or connected remotely to one or more nodes using TransportClient.

See Also:

Node.client(), TransportClient

Method Summary

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.
void	close() Closes the client.
ActionFuture<CountResponse>	count(CountRequest request) A count of all the documents matching a specific query.
void	count(CountRequest request, ActionListener<CountResponse> listener) A count of all the documents matching a specific query.
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.
ActionFuture<DeleteByQueryResponse>	deleteByQuery(DeleteByQueryRequest request) Deletes all documents from one or more indices based on a query.
void	deleteByQuery(DeleteByQueryRequest request, ActionListener<DeleteByQueryResponse> listener) Deletes all documents from one or more indices based on a query.
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> 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>> void	execute(Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener) Executes a generic action, denoted by an Action.
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<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<SearchResponse>	moreLikeThis(MoreLikeThisRequest request) A more like this action to search for documents that are "like" a specific document.
void	moreLikeThis(MoreLikeThisRequest request, ActionListener<SearchResponse> listener) A more like this action to search for documents that are "like" a specific document.
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<PercolateResponse>	percolate(PercolateRequest request) Percolates a request returning the matches documents.
void	percolate(PercolateRequest request, ActionListener<PercolateResponse> listener) Percolates a request returning the matches documents.
BulkRequestBuilder	prepareBulk() Executes a bulk of index / delete operations.
CountRequestBuilder	prepareCount(String... indices) A count of all the documents matching a specific query.
DeleteRequestBuilder	prepareDelete() Deletes a document from the index based on the index, type and id.
DeleteRequestBuilder	prepareDelete(String index, String type, String id) Deletes a document from the index based on the index, type and id.
DeleteByQueryRequestBuilder	prepareDeleteByQuery(String... indices) Deletes all documents from one or more indices based on a query.
<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> RequestBuilder	prepareExecute(Action<Request,Response,RequestBuilder> action) Prepares a request builder to execute, specified by Action.
ExplainRequestBuilder	prepareExplain(String index, String type, String id) Computes a score explanation for the specified request.
GetRequestBuilder	prepareGet() Gets the document that was indexed from an index with a type and id.
GetRequestBuilder	prepareGet(String index, String type, 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(String index, String type) Index a document associated with a given index and type.
IndexRequestBuilder	prepareIndex(String index, String type, String id) Index a document associated with a given index and type.
MoreLikeThisRequestBuilder	prepareMoreLikeThis(String index, String type, String id) A more like this action to search for documents that are "like" a specific document.
MultiGetRequestBuilder	prepareMultiGet() Multi get documents.
MultiSearchRequestBuilder	prepareMultiSearch() Performs multiple search requests.
PercolateRequestBuilder	preparePercolate(String index, String type) Percolates a request returning the matches documents.
SearchRequestBuilder	prepareSearch(String... indices) Search across one or more indices and one or more types with a query.
SearchScrollRequestBuilder	prepareSearchScroll(String scrollId) A search scroll request to continue searching a previous scrollable search request.
UpdateRequestBuilder	prepareUpdate() Updates a document based on a script.
UpdateRequestBuilder	prepareUpdate(String index, String type, 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.
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.

Method Detail

close

void close()

Closes the client.

admin

AdminClient admin()

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

execute

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

Executes a generic action, denoted by an Action.

Type Parameters:

Request - Teh 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

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

Executes a generic action, denoted by an Action.

Type Parameters:

Request - The request type.

Response - The response type.

RequestBuilder - The request builder type.

Parameters:

action - The action type to execute.

request - Teh action request.

listener - The listener to receive the response back.

prepareExecute

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

Prepares a request builder to execute, specified by Action.

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.

index

ActionFuture<IndexResponse> index(IndexRequest request)

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.

Parameters:

request - The index request

Returns:

The result future

See Also:

Requests.indexRequest(String)

index

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

Index a document associated with a given index and type.

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

Parameters:

request - The index request

listener - A listener to be notified with a result

See Also:

Requests.indexRequest(String)

prepareIndex

IndexRequestBuilder prepareIndex()

Index a document associated with a given index and type.

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

update

ActionFuture<UpdateResponse> update(UpdateRequest request)

Updates a document based on a script.

Parameters:

request - The update request

Returns:

The result future

update

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

Updates a document based on a script.

Parameters:

request - The update request

listener - A listener to be notified with a result

prepareUpdate

UpdateRequestBuilder prepareUpdate()

Updates a document based on a script.

prepareUpdate

UpdateRequestBuilder prepareUpdate(String index,
                                   String type,
                                   String id)

Updates a document based on a script.

prepareIndex

IndexRequestBuilder prepareIndex(String index,
                                 String type)

Index a document associated with a given index and type.

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

Parameters:

index - The index to index the document to

type - The type to index the document to

prepareIndex

IndexRequestBuilder prepareIndex(String index,
                                 String type,
                                 @Nullable
                                 String id)

Index a document associated with a given index and type.

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

Parameters:

index - The index to index the document to

type - The type to index the document to

id - The id of the document

delete

ActionFuture<DeleteResponse> delete(DeleteRequest request)

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

Parameters:

request - The delete request

Returns:

The result future

See Also:

Requests.deleteRequest(String)

delete

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

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

Parameters:

request - The delete request

listener - A listener to be notified with a result

See Also:

Requests.deleteRequest(String)

prepareDelete

DeleteRequestBuilder prepareDelete()

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

prepareDelete

DeleteRequestBuilder prepareDelete(String index,
                                   String type,
                                   String id)

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

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

ActionFuture<BulkResponse> bulk(BulkRequest request)

Executes a bulk of index / delete operations.

Parameters:

request - The bulk request

Returns:

The result future

See Also:

Requests.bulkRequest()

bulk

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

Executes a bulk of index / delete operations.

Parameters:

request - The bulk request

listener - A listener to be notified with a result

See Also:

Requests.bulkRequest()

prepareBulk

BulkRequestBuilder prepareBulk()

Executes a bulk of index / delete operations.

deleteByQuery

ActionFuture<DeleteByQueryResponse> deleteByQuery(DeleteByQueryRequest request)

Deletes all documents from one or more indices based on a query.

Parameters:

request - The delete by query request

Returns:

The result future

See Also:

Requests.deleteByQueryRequest(String...)

deleteByQuery

void deleteByQuery(DeleteByQueryRequest request,
                   ActionListener<DeleteByQueryResponse> listener)

Deletes all documents from one or more indices based on a query.

Parameters:

request - The delete by query request

listener - A listener to be notified with a result

See Also:

Requests.deleteByQueryRequest(String...)

prepareDeleteByQuery

DeleteByQueryRequestBuilder prepareDeleteByQuery(String... indices)

Deletes all documents from one or more indices based on a query.

get

ActionFuture<GetResponse> get(GetRequest request)

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

Parameters:

request - The get request

Returns:

The result future

See Also:

Requests.getRequest(String)

get

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

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

Parameters:

request - The get request

listener - A listener to be notified with a result

See Also:

Requests.getRequest(String)

prepareGet

GetRequestBuilder prepareGet()

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

prepareGet

GetRequestBuilder prepareGet(String index,
                             @Nullable
                             String type,
                             String id)

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

multiGet

ActionFuture<MultiGetResponse> multiGet(MultiGetRequest request)

Multi get documents.

multiGet

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

Multi get documents.

prepareMultiGet

MultiGetRequestBuilder prepareMultiGet()

Multi get documents.

count

ActionFuture<CountResponse> count(CountRequest request)

A count of all the documents matching a specific query.

Parameters:

request - The count request

Returns:

The result future

See Also:

Requests.countRequest(String...)

count

void count(CountRequest request,
           ActionListener<CountResponse> listener)

A count of all the documents matching a specific query.

Parameters:

request - The count request

listener - A listener to be notified of the result

See Also:

Requests.countRequest(String...)

prepareCount

CountRequestBuilder prepareCount(String... indices)

A count of all the documents matching a specific query.

search

ActionFuture<SearchResponse> search(SearchRequest request)

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

Parameters:

request - The search request

Returns:

The result future

See Also:

Requests.searchRequest(String...)

search

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

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

Parameters:

request - The search request

listener - A listener to be notified of the result

See Also:

Requests.searchRequest(String...)

prepareSearch

SearchRequestBuilder prepareSearch(String... indices)

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

searchScroll

ActionFuture<SearchResponse> searchScroll(SearchScrollRequest request)

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

Parameters:

request - The search scroll request

Returns:

The result future

See Also:

Requests.searchScrollRequest(String)

searchScroll

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

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

Parameters:

request - The search scroll request

listener - A listener to be notified of the result

See Also:

Requests.searchScrollRequest(String)

prepareSearchScroll

SearchScrollRequestBuilder prepareSearchScroll(String scrollId)

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

multiSearch

ActionFuture<MultiSearchResponse> multiSearch(MultiSearchRequest request)

Performs multiple search requests.

multiSearch

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

Performs multiple search requests.

prepareMultiSearch

MultiSearchRequestBuilder prepareMultiSearch()

Performs multiple search requests.

moreLikeThis

ActionFuture<SearchResponse> moreLikeThis(MoreLikeThisRequest request)

A more like this action to search for documents that are "like" a specific document.

Parameters:

request - The more like this request

Returns:

The response future

moreLikeThis

void moreLikeThis(MoreLikeThisRequest request,
                  ActionListener<SearchResponse> listener)

A more like this action to search for documents that are "like" a specific document.

Parameters:

request - The more like this request

listener - A listener to be notified of the result

prepareMoreLikeThis

MoreLikeThisRequestBuilder prepareMoreLikeThis(String index,
                                               String type,
                                               String id)

A more like this action to search for documents that are "like" a specific document.

Parameters:

index - The index to load the document from

type - The type of the document

id - The id of the document

percolate

ActionFuture<PercolateResponse> percolate(PercolateRequest request)

Percolates a request returning the matches documents.

percolate

void percolate(PercolateRequest request,
               ActionListener<PercolateResponse> listener)

Percolates a request returning the matches documents.

preparePercolate

PercolateRequestBuilder preparePercolate(String index,
                                         String type)

Percolates a request returning the matches documents.

Parameters:

index - The index to percolate the doc

type - The type of the doc

prepareExplain

ExplainRequestBuilder prepareExplain(String index,
                                     String type,
                                     String id)

Computes a score explanation for the specified request.

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

ActionFuture<ExplainResponse> explain(ExplainRequest request)

Computes a score explanation for the specified request.

Parameters:

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

explain

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

Computes a score explanation for the specified request.

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