|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.elasticsearch.client.support.AbstractClient org.elasticsearch.client.transport.TransportClient
public class TransportClient
The transport client allows to create a client that is not part of the cluster, but simply connects to one
or more nodes directly by adding their respective addresses using addTransportAddress(org.elasticsearch.common.transport.TransportAddress)
.
The transport client important modules used is the TransportModule
which is
started in client mode (only connects, no bind).
Constructor Summary | |
---|---|
TransportClient()
Constructs a new transport client with settings loaded either from the classpath or the file system (the elasticsearch.(yml|json) files optionally prefixed with config/). |
|
TransportClient(Settings.Builder settings)
Constructs a new transport client with explicit settings and settings loaded either from the classpath or the file system (the elasticsearch.(yml|json) files optionally prefixed with config/). |
|
TransportClient(Settings.Builder settings,
boolean loadConfigSettings)
Constructs a new transport client with the provided settings and the ability to control if settings will be loaded from the classpath / file system (the elasticsearch.(yml|json) files optionally prefixed with config/). |
|
TransportClient(Settings settings)
Constructs a new transport client with explicit settings and settings loaded either from the classpath or the file system (the elasticsearch.(yml|json) files optionally prefixed with config/). |
|
TransportClient(Settings pSettings,
boolean loadConfigSettings)
Constructs a new transport client with the provided settings and the ability to control if settings will be loaded from the classpath / file system (the elasticsearch.(yml|json) files optionally prefixed with config/). |
Method Summary | ||
---|---|---|
TransportClient |
addTransportAddress(TransportAddress transportAddress)
Adds a transport address that will be used to connect to. |
|
TransportClient |
addTransportAddresses(TransportAddress... transportAddress)
Adds a list of transport addresses that will be used to connect to. |
|
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. |
|
com.google.common.collect.ImmutableList<DiscoveryNode> |
connectedNodes()
Returns the current connected transport nodes that this client will use. |
|
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. |
|
|
execute(Action<Request,Response,RequestBuilder> action,
Request request)
Executes a generic action, denoted by an Action . |
|
|
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. |
|
com.google.common.collect.ImmutableList<DiscoveryNode> |
listedNodes()
Returns the listed nodes in the transport client (ones added to it). |
|
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. |
|
TransportClient |
removeTransportAddress(TransportAddress transportAddress)
Removes a transport address from the list of transport addresses that are used to connect to. |
|
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()
|
|
ThreadPool |
threadPool()
|
|
com.google.common.collect.ImmutableList<TransportAddress> |
transportAddresses()
Returns the current registered transport addresses to use (added using addTransportAddress(org.elasticsearch.common.transport.TransportAddress) . |
|
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.client.support.AbstractClient |
---|
prepareBulk, prepareCount, prepareDelete, prepareDelete, prepareDeleteByQuery, prepareExecute, prepareExplain, prepareGet, prepareGet, prepareIndex, prepareIndex, prepareIndex, prepareMoreLikeThis, prepareMultiGet, prepareMultiSearch, preparePercolate, prepareSearch, prepareSearchScroll, prepareUpdate, prepareUpdate |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public TransportClient() throws ElasticSearchException
ElasticSearchException
public TransportClient(Settings settings)
public TransportClient(Settings.Builder settings)
public TransportClient(Settings.Builder settings, boolean loadConfigSettings) throws ElasticSearchException
settings
- The explicit settings.loadConfigSettings
- true if settings should be loaded from the classpath/file system.
ElasticSearchException
public TransportClient(Settings pSettings, boolean loadConfigSettings) throws ElasticSearchException
pSettings
- The explicit settings.loadConfigSettings
- true if settings should be loaded from the classpath/file system.
ElasticSearchException
Method Detail |
---|
public com.google.common.collect.ImmutableList<TransportAddress> transportAddresses()
addTransportAddress(org.elasticsearch.common.transport.TransportAddress)
.
public com.google.common.collect.ImmutableList<DiscoveryNode> connectedNodes()
The nodes include all the nodes that are currently alive based on the transport addresses provided.
public com.google.common.collect.ImmutableList<DiscoveryNode> listedNodes()
public TransportClient addTransportAddress(TransportAddress transportAddress)
The Node this transport address represents will be used if its possible to connect to it. If it is unavailable, it will be automatically connected to once it is up.
In order to get the list of all the current connected nodes, please see connectedNodes()
.
public TransportClient addTransportAddresses(TransportAddress... transportAddress)
The Node this transport address represents will be used if its possible to connect to it. If it is unavailable, it will be automatically connected to once it is up.
In order to get the list of all the current connected nodes, please see connectedNodes()
.
public TransportClient removeTransportAddress(TransportAddress transportAddress)
public void close()
public Settings settings()
public ThreadPool threadPool()
public AdminClient admin()
Client
public <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> ActionFuture<Response> execute(Action<Request,Response,RequestBuilder> action, Request request)
Client
Action
.
Request
- Teh request type.Response
- the response type.RequestBuilder
- The request builder type.action
- The action type to execute.request
- The action request.
public <Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response>> void execute(Action<Request,Response,RequestBuilder> action, Request request, ActionListener<Response> listener)
Client
Action
.
Request
- The request type.Response
- The response type.RequestBuilder
- The request builder type.action
- The action type to execute.request
- Teh action request.listener
- The listener to receive the response back.public ActionFuture<IndexResponse> index(IndexRequest request)
Client
The id is optional, if it is not provided, one will be generated automatically.
index
in interface Client
index
in class AbstractClient
request
- The index request
Requests.indexRequest(String)
public void index(IndexRequest request, ActionListener<IndexResponse> listener)
Client
The id is optional, if it is not provided, one will be generated automatically.
index
in interface Client
index
in class AbstractClient
request
- The index requestlistener
- A listener to be notified with a resultRequests.indexRequest(String)
public ActionFuture<UpdateResponse> update(UpdateRequest request)
Client
update
in interface Client
update
in class AbstractClient
request
- The update request
public void update(UpdateRequest request, ActionListener<UpdateResponse> listener)
Client
update
in interface Client
update
in class AbstractClient
request
- The update requestlistener
- A listener to be notified with a resultpublic ActionFuture<DeleteResponse> delete(DeleteRequest request)
Client
delete
in interface Client
delete
in class AbstractClient
request
- The delete request
Requests.deleteRequest(String)
public void delete(DeleteRequest request, ActionListener<DeleteResponse> listener)
Client
delete
in interface Client
delete
in class AbstractClient
request
- The delete requestlistener
- A listener to be notified with a resultRequests.deleteRequest(String)
public ActionFuture<BulkResponse> bulk(BulkRequest request)
Client
bulk
in interface Client
bulk
in class AbstractClient
request
- The bulk request
Requests.bulkRequest()
public void bulk(BulkRequest request, ActionListener<BulkResponse> listener)
Client
bulk
in interface Client
bulk
in class AbstractClient
request
- The bulk requestlistener
- A listener to be notified with a resultRequests.bulkRequest()
public ActionFuture<DeleteByQueryResponse> deleteByQuery(DeleteByQueryRequest request)
Client
deleteByQuery
in interface Client
deleteByQuery
in class AbstractClient
request
- The delete by query request
Requests.deleteByQueryRequest(String...)
public void deleteByQuery(DeleteByQueryRequest request, ActionListener<DeleteByQueryResponse> listener)
Client
deleteByQuery
in interface Client
deleteByQuery
in class AbstractClient
request
- The delete by query requestlistener
- A listener to be notified with a resultRequests.deleteByQueryRequest(String...)
public ActionFuture<GetResponse> get(GetRequest request)
Client
get
in interface Client
get
in class AbstractClient
request
- The get request
Requests.getRequest(String)
public void get(GetRequest request, ActionListener<GetResponse> listener)
Client
get
in interface Client
get
in class AbstractClient
request
- The get requestlistener
- A listener to be notified with a resultRequests.getRequest(String)
public ActionFuture<MultiGetResponse> multiGet(MultiGetRequest request)
Client
multiGet
in interface Client
multiGet
in class AbstractClient
public void multiGet(MultiGetRequest request, ActionListener<MultiGetResponse> listener)
Client
multiGet
in interface Client
multiGet
in class AbstractClient
public ActionFuture<CountResponse> count(CountRequest request)
Client
count
in interface Client
count
in class AbstractClient
request
- The count request
Requests.countRequest(String...)
public void count(CountRequest request, ActionListener<CountResponse> listener)
Client
count
in interface Client
count
in class AbstractClient
request
- The count requestlistener
- A listener to be notified of the resultRequests.countRequest(String...)
public ActionFuture<SearchResponse> search(SearchRequest request)
Client
search
in interface Client
search
in class AbstractClient
request
- The search request
Requests.searchRequest(String...)
public void search(SearchRequest request, ActionListener<SearchResponse> listener)
Client
search
in interface Client
search
in class AbstractClient
request
- The search requestlistener
- A listener to be notified of the resultRequests.searchRequest(String...)
public ActionFuture<SearchResponse> searchScroll(SearchScrollRequest request)
Client
searchScroll
in interface Client
searchScroll
in class AbstractClient
request
- The search scroll request
Requests.searchScrollRequest(String)
public void searchScroll(SearchScrollRequest request, ActionListener<SearchResponse> listener)
Client
searchScroll
in interface Client
searchScroll
in class AbstractClient
request
- The search scroll requestlistener
- A listener to be notified of the resultRequests.searchScrollRequest(String)
public ActionFuture<MultiSearchResponse> multiSearch(MultiSearchRequest request)
Client
multiSearch
in interface Client
multiSearch
in class AbstractClient
public void multiSearch(MultiSearchRequest request, ActionListener<MultiSearchResponse> listener)
Client
multiSearch
in interface Client
multiSearch
in class AbstractClient
public ActionFuture<SearchResponse> moreLikeThis(MoreLikeThisRequest request)
Client
moreLikeThis
in interface Client
moreLikeThis
in class AbstractClient
request
- The more like this request
public void moreLikeThis(MoreLikeThisRequest request, ActionListener<SearchResponse> listener)
Client
moreLikeThis
in interface Client
moreLikeThis
in class AbstractClient
request
- The more like this requestlistener
- A listener to be notified of the resultpublic ActionFuture<PercolateResponse> percolate(PercolateRequest request)
Client
percolate
in interface Client
percolate
in class AbstractClient
public void percolate(PercolateRequest request, ActionListener<PercolateResponse> listener)
Client
percolate
in interface Client
percolate
in class AbstractClient
public ActionFuture<ExplainResponse> explain(ExplainRequest request)
Client
explain
in interface Client
explain
in class AbstractClient
request
- The request encapsulating the query and document identifier to compute a score explanation forpublic void explain(ExplainRequest request, ActionListener<ExplainResponse> listener)
Client
explain
in interface Client
explain
in class AbstractClient
request
- The request encapsulating the query and document identifier to compute a score explanation forlistener
- A listener to be notified of the result
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |