TransportClient (elasticsearch 0.14.0 API)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.elasticsearch.client.transport
Class TransportClient

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

All Implemented Interfaces:: Client, InternalClient

public class TransportClient
extends AbstractClient
extends AbstractClient

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.
`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.
`org.elasticsearch.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.
`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.
`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.
`ThreadPool`	`threadPool()`
`org.elasticsearch.common.collect.ImmutableList<TransportAddress>`	`transportAddresses()` Returns the current registered transport addresses to use (added using `addTransportAddress(org.elasticsearch.common.transport.TransportAddress)`.

Methods inherited from class org.elasticsearch.client.support.AbstractClient
`prepareBulk, prepareCount, prepareDelete, prepareDelete, prepareDeleteByQuery, prepareGet, prepareGet, prepareIndex, prepareIndex, prepareIndex, prepareSearch, prepareSearchScroll`

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

public TransportClient(Settings.Builder settings,
                       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:: settings - The explicit settings.; loadConfigSettings - true if settings should be loaded from the classpath/file system.
Throws:: ElasticSearchException

TransportClient

public TransportClient(Settings pSettings,
                       boolean loadConfigSettings)
                throws ElasticSearchException

Parameters:: pSettings - The explicit settings.; loadConfigSettings - true if settings should be loaded from the classpath/file system.
Throws:: ElasticSearchException

Method Detail

transportAddresses

public org.elasticsearch.common.collect.ImmutableList<TransportAddress> transportAddresses()

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

connectedNodes

public org.elasticsearch.common.collect.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.