org.elasticsearch.client.transport
Class TransportClient

java.lang.Object
  org.elasticsearch.client.transport.TransportClient

All Implemented Interfaces:

Client, InternalClient

public class TransportClient
extends java.lang.Object
implements InternalClient

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.util.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 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.
AdminClient	admin() The admin client that can be used to perform administrative operations.
void	close() Closes the client.
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.
ActionFuture<GetResponse>	get(GetRequest request) Gets the JSON source that was indexed from an index with a type and id.
void	get(GetRequest request, ActionListener<GetResponse> listener) Gets the JSON source 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 JSON source 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.
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.
ActionFuture<TermsResponse>	terms(TermsRequest request) A terms request to get terms in one or more indices of specific fields and their document frequencies (in how many document each term exists).
void	terms(TermsRequest request, ActionListener<TermsResponse> listener) A terms request to get terms in one or more indices of specific fields and their document frequencies (in how many document each term exists).
ThreadPool	threadPool()
ImmutableList<TransportAddress>	transportAddresses() Returns the current registered transport addresses to use (added using addTransportAddress(org.elasticsearch.util.transport.TransportAddress).

Methods inherited from class java.lang.Object

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

Constructor Detail

TransportClient

public TransportClient()
                throws ElasticSearchException

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/).

Throws:

ElasticSearchException

TransportClient

public 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

public TransportClient(Settings pSettings,
                       boolean loadConfigSettings)
                throws ElasticSearchException

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/).

Parameters:

pSettings - The explicit settings.

loadConfigSettings - true if settings should be loaded from the classpath/file system.

Throws:

ElasticSearchException

Method Detail

transportAddresses

public ImmutableList<TransportAddress> transportAddresses()

Returns the current registered transport addresses to use (added using addTransportAddress(org.elasticsearch.util.transport.TransportAddress).

connectedNodes

public ImmutableList<DiscoveryNode> connectedNodes()

Returns the current connected transport nodes that this client will use.

The nodes include all the nodes that are currently alive based on the transport addresses provided.

addTransportAddress

public TransportClient addTransportAddress(TransportAddress transportAddress)

Adds a transport address that will be used to connect to.

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().

removeTransportAddress

public TransportClient removeTransportAddress(TransportAddress transportAddress)

Removes a transport address from the list of transport addresses that are used to connect to.

close

public void close()

Closes the client.

Specified by:

close in interface Client

threadPool

public ThreadPool threadPool()

Specified by:

threadPool in interface InternalClient

admin

public AdminClient admin()

Description copied from interface: Client

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

Specified by:

admin in interface Client

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

listener - A listener to be notified with a result

See Also:

Requests.indexRequest(String)

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)

deleteByQuery

public ActionFuture<DeleteByQueryResponse> deleteByQuery(DeleteByQueryRequest request)

Description copied from interface: Client

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

Specified by:

deleteByQuery in interface Client

Parameters:

request - The delete by query request

Returns:

The result future

See Also:

Requests.deleteByQueryRequest(String...)

deleteByQuery

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

Description copied from interface: Client

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

Specified by:

deleteByQuery in interface Client

Parameters:

request - The delete by query request

listener - A listener to be notified with a result

See Also:

Requests.deleteByQueryRequest(String...)

get

public ActionFuture<GetResponse> get(GetRequest request)

Description copied from interface: Client

Gets the JSON source 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 JSON source 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)

count

public ActionFuture<CountResponse> count(CountRequest request)

Description copied from interface: Client

A count of all the documents matching a specific query.

Specified by:

count in interface Client

Parameters:

request - The count request

Returns:

The result future

See Also:

Requests.countRequest(String...)

count

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

Description copied from interface: Client

A count of all the documents matching a specific query.

Specified by:

count in interface Client

Parameters:

request - The count request

listener - A listener to be notified of the result

See Also:

Requests.countRequest(String...)

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...)

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)

terms

public ActionFuture<TermsResponse> terms(TermsRequest request)

Description copied from interface: Client

A terms request to get terms in one or more indices of specific fields and their document frequencies (in how many document each term exists).

Specified by:

terms in interface Client

Parameters:

request - The term request

Returns:

The result future

See Also:

Requests.termsRequest(String...)

terms

public void terms(TermsRequest request,
                  ActionListener<TermsResponse> listener)

Description copied from interface: Client

A terms request to get terms in one or more indices of specific fields and their document frequencies (in how many document each term exists).

Specified by:

terms in interface Client

Parameters:

request - The term request

listener - A listener to be notified of the result

See Also:

Requests.termsRequest(String...)

moreLikeThis

public ActionFuture<SearchResponse> moreLikeThis(MoreLikeThisRequest request)

Description copied from interface: Client

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

Specified by:

moreLikeThis in interface Client

Parameters:

request - The more like this request

Returns:

The response future

moreLikeThis

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

Description copied from interface: Client

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

Specified by:

moreLikeThis in interface Client

Parameters:

request - The more like this request

listener - A listener to be notified of the result