Module org.elasticsearch.server
Interface RemoteClusterClient
public interface RemoteClusterClient
A client which can execute requests on a specific remote cluster.
-
Method Summary
Modifier and TypeMethodDescriptiondefault <Request extends ActionRequest,
Response extends TransportResponse>
voidexecute
(RemoteClusterActionType<Response> action, Request request, ActionListener<Response> listener) Executes an action, denoted by anActionType
, on the remote cluster.<Request extends ActionRequest,
Response extends TransportResponse>
voidexecute
(Transport.Connection connection, RemoteClusterActionType<Response> action, Request request, ActionListener<Response> listener) Executes an action, denoted by anActionType
, using a connection to the remote cluster obtained usinggetConnection(Request, org.elasticsearch.action.ActionListener<org.elasticsearch.transport.Transport.Connection>)
.<Request extends ActionRequest>
voidgetConnection
(Request request, ActionListener<Transport.Connection> listener) Obtain a connection to the remote cluster for use with theexecute(org.elasticsearch.action.RemoteClusterActionType<Response>, Request, org.elasticsearch.action.ActionListener<Response>)
override that allows to specify the connection.
-
Method Details
-
execute
default <Request extends ActionRequest,Response extends TransportResponse> void execute(RemoteClusterActionType<Response> action, Request request, ActionListener<Response> listener) Executes an action, denoted by anActionType
, on the remote cluster. -
execute
<Request extends ActionRequest,Response extends TransportResponse> void execute(Transport.Connection connection, RemoteClusterActionType<Response> action, Request request, ActionListener<Response> listener) Executes an action, denoted by anActionType
, using a connection to the remote cluster obtained usinggetConnection(Request, org.elasticsearch.action.ActionListener<org.elasticsearch.transport.Transport.Connection>)
. -
getConnection
<Request extends ActionRequest> void getConnection(@Nullable Request request, ActionListener<Transport.Connection> listener) Obtain a connection to the remote cluster for use with theexecute(org.elasticsearch.action.RemoteClusterActionType<Response>, Request, org.elasticsearch.action.ActionListener<Response>)
override that allows to specify the connection. Useful for cases where you need to inspectTransport.getVersion()
before deciding the exact remote action to invoke.
-