|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
.
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. |
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<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(java.lang.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(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. |
DeleteByQueryRequestBuilder |
prepareDeleteByQuery(java.lang.String... indices)
Deletes all documents from one or more indices based on a query. |
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 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. |
PercolateRequestBuilder |
preparePercolate(java.lang.String index,
java.lang.String type)
Percolates a request returning the matches documents. |
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. |
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. |
Method Detail |
---|
void close()
AdminClient admin()
ActionFuture<IndexResponse> index(IndexRequest request)
The id is optional, if it is not provided, one will be generated automatically.
request
- The index request
Requests.indexRequest(String)
void index(IndexRequest request, ActionListener<IndexResponse> listener)
The id is optional, if it is not provided, one will be generated automatically.
request
- The index requestlistener
- A listener to be notified with a resultRequests.indexRequest(String)
IndexRequestBuilder prepareIndex()
The id is optional, if it is not provided, one will be generated automatically.
IndexRequestBuilder prepareIndex(java.lang.String index, java.lang.String type)
The id is optional, if it is not provided, one will be generated automatically.
index
- The index to index the document totype
- The type to index the document toIndexRequestBuilder prepareIndex(java.lang.String index, java.lang.String type, @Nullable java.lang.String id)
The id is optional, if it is not provided, one will be generated automatically.
index
- The index to index the document totype
- The type to index the document toid
- The id of the documentActionFuture<DeleteResponse> delete(DeleteRequest request)
request
- The delete request
Requests.deleteRequest(String)
void delete(DeleteRequest request, ActionListener<DeleteResponse> listener)
request
- The delete requestlistener
- A listener to be notified with a resultRequests.deleteRequest(String)
DeleteRequestBuilder prepareDelete()
DeleteRequestBuilder prepareDelete(java.lang.String index, java.lang.String type, java.lang.String id)
index
- The index to delete the document fromtype
- The type of the document to deleteid
- The id of the document to deleteActionFuture<BulkResponse> bulk(BulkRequest request)
request
- The bulk request
Requests.bulkRequest()
void bulk(BulkRequest request, ActionListener<BulkResponse> listener)
request
- The bulk requestlistener
- A listener to be notified with a resultRequests.bulkRequest()
BulkRequestBuilder prepareBulk()
ActionFuture<DeleteByQueryResponse> deleteByQuery(DeleteByQueryRequest request)
request
- The delete by query request
Requests.deleteByQueryRequest(String...)
void deleteByQuery(DeleteByQueryRequest request, ActionListener<DeleteByQueryResponse> listener)
request
- The delete by query requestlistener
- A listener to be notified with a resultRequests.deleteByQueryRequest(String...)
DeleteByQueryRequestBuilder prepareDeleteByQuery(java.lang.String... indices)
ActionFuture<GetResponse> get(GetRequest request)
request
- The get request
Requests.getRequest(String)
void get(GetRequest request, ActionListener<GetResponse> listener)
request
- The get requestlistener
- A listener to be notified with a resultRequests.getRequest(String)
GetRequestBuilder prepareGet()
GetRequestBuilder prepareGet(java.lang.String index, java.lang.String type, java.lang.String id)
ActionFuture<CountResponse> count(CountRequest request)
request
- The count request
Requests.countRequest(String...)
void count(CountRequest request, ActionListener<CountResponse> listener)
request
- The count requestlistener
- A listener to be notified of the resultRequests.countRequest(String...)
CountRequestBuilder prepareCount(java.lang.String... indices)
ActionFuture<SearchResponse> search(SearchRequest request)
request
- The search request
Requests.searchRequest(String...)
void search(SearchRequest request, ActionListener<SearchResponse> listener)
request
- The search requestlistener
- A listener to be notified of the resultRequests.searchRequest(String...)
SearchRequestBuilder prepareSearch(java.lang.String... indices)
ActionFuture<SearchResponse> searchScroll(SearchScrollRequest request)
request
- The search scroll request
Requests.searchScrollRequest(String)
void searchScroll(SearchScrollRequest request, ActionListener<SearchResponse> listener)
request
- The search scroll requestlistener
- A listener to be notified of the resultRequests.searchScrollRequest(String)
SearchScrollRequestBuilder prepareSearchScroll(java.lang.String scrollId)
ActionFuture<SearchResponse> moreLikeThis(MoreLikeThisRequest request)
request
- The more like this request
void moreLikeThis(MoreLikeThisRequest request, ActionListener<SearchResponse> listener)
request
- The more like this requestlistener
- A listener to be notified of the resultActionFuture<PercolateResponse> percolate(PercolateRequest request)
void percolate(PercolateRequest request, ActionListener<PercolateResponse> listener)
PercolateRequestBuilder preparePercolate(java.lang.String index, java.lang.String type)
index
- The index to percolate the doctype
- The type of the doc
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |