Package org.elasticsearch.transport.client

Class PreBuiltTransportClient

java.lang.Object

org.elasticsearch.common.component.AbstractComponent

org.elasticsearch.client.support.AbstractClient

org.elasticsearch.client.transport.TransportClient

org.elasticsearch.transport.client.PreBuiltTransportClient

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, Client, ElasticsearchClient, Releasable

public class PreBuiltTransportClient
extends TransportClient

A builder to create an instance of TransportClient. This class pre-installs the Netty4Plugin, ReindexPlugin, PercolatorPlugin, MustachePlugin, ParentJoinPlugin plugins for the client. These plugins are all the required modules for Elasticsearch. Note that TransportClient will be deprecated in Elasticsearch 7.0 and removed in Elasticsearch 8.0. Use the High Level REST Client instead.

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.client.transport.TransportClient

TransportClient.HostFailureListener

Field Summary

Fields inherited from class org.elasticsearch.common.component.AbstractComponent

deprecationLogger, logger, settings

Fields inherited from interface org.elasticsearch.client.Client

CLIENT_TYPE_SETTING_S

Fields inherited from class org.elasticsearch.client.transport.TransportClient

CLIENT_TRANSPORT_IGNORE_CLUSTER_NAME, CLIENT_TRANSPORT_NODES_SAMPLER_INTERVAL, CLIENT_TRANSPORT_PING_TIMEOUT, CLIENT_TRANSPORT_SNIFF, CLIENT_TYPE, namedWriteableRegistry, TRANSPORT_CLIENT_FEATURE

Constructor Summary

Constructors

Constructor	Description
PreBuiltTransportClient(Settings settings, java.lang.Class<? extends Plugin>... plugins)	Creates a new transport client with pre-installed plugins.
PreBuiltTransportClient(Settings settings, java.util.Collection<java.lang.Class<? extends Plugin>> plugins)	Creates a new transport client with pre-installed plugins.
PreBuiltTransportClient(Settings settings, java.util.Collection<java.lang.Class<? extends Plugin>> plugins, TransportClient.HostFailureListener hostFailureListener)	Creates a new transport client with pre-installed plugins.

Method Summary

Modifier and Type	Method	Description
void	close()

Methods inherited from class org.elasticsearch.client.support.AbstractClient

admin, bulk, bulk, clearScroll, clearScroll, delete, delete, execute, execute, explain, explain, fieldCaps, fieldCaps, filterWithHeader, get, get, index, index, multiGet, multiGet, multiSearch, multiSearch, multiTermVectors, multiTermVectors, prepareBulk, prepareClearScroll, prepareDelete, prepareDelete, prepareExecute, prepareExplain, prepareFieldCaps, prepareGet, prepareGet, prepareIndex, prepareIndex, prepareIndex, prepareMultiGet, prepareMultiSearch, prepareMultiTermVectors, prepareSearch, prepareSearchScroll, prepareTermVector, prepareTermVector, prepareTermVectors, prepareTermVectors, prepareUpdate, prepareUpdate, search, search, searchScroll, searchScroll, settings, termVector, termVector, termVectors, termVectors, threadPool, update, update

Methods inherited from class org.elasticsearch.common.component.AbstractComponent

logDeprecatedSetting, logRemovedSetting, nodeName

Methods inherited from interface org.elasticsearch.client.Client

getRemoteClusterClient

Methods inherited from class java.lang.Object

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

Methods inherited from class org.elasticsearch.client.transport.TransportClient

addPlugins, addPlugins, addTransportAddress, addTransportAddresses, connectedNodes, doExecute, filteredNodes, listedNodes, removeTransportAddress, transportAddresses

Constructor Detail

PreBuiltTransportClient

@SafeVarargs
public PreBuiltTransportClient(Settings settings,
                               java.lang.Class<? extends Plugin>... plugins)

Creates a new transport client with pre-installed plugins.

Parameters:

settings - the settings passed to this transport client

plugins - an optional array of additional plugins to run with this client

PreBuiltTransportClient

public PreBuiltTransportClient(Settings settings,
                               java.util.Collection<java.lang.Class<? extends Plugin>> plugins)

Creates a new transport client with pre-installed plugins.

Parameters:

settings - the settings passed to this transport client

plugins - a collection of additional plugins to run with this client

PreBuiltTransportClient

public PreBuiltTransportClient(Settings settings,
                               java.util.Collection<java.lang.Class<? extends Plugin>> plugins,
                               TransportClient.HostFailureListener hostFailureListener)

Creates a new transport client with pre-installed plugins.

Parameters:

settings - the settings passed to this transport client

plugins - a collection of additional plugins to run with this client

hostFailureListener - a failure listener that is invoked if a node is disconnected; this can be null

Method Detail

close

public void close()

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface Releasable

Overrides:

close in class TransportClient