Module org.elasticsearch.server

Package org.elasticsearch.action

Class RemoteClusterActionType<Response extends TransportResponse>

java.lang.Object

org.elasticsearch.action.RemoteClusterActionType<Response>

public final class RemoteClusterActionType<Response extends TransportResponse>
extends Object

An action which can be invoked by RemoteClusterClient.execute(org.elasticsearch.action.RemoteClusterActionType<Response>, Request, org.elasticsearch.action.ActionListener<Response>). The implementation must be registered with the transport service.

Typically, every RemoteClusterActionType instance is a global constant (i.e. a public static final field) called REMOTE_TYPE.

Constructor Summary

Constructors

Constructor	Description
RemoteClusterActionType(String name, Writeable.Reader<Response> responseReader)	Construct an ActionType which callers can execute on a remote cluster using a RemoteClusterClient, typically obtained from Client.getRemoteClusterClient(java.lang.String, java.util.concurrent.Executor)).

Method Summary

Modifier and Type	Method	Description
static RemoteClusterActionType<ActionResponse.Empty>	emptyResponse(String name)
boolean	equals(Object o)
Writeable.Reader<Response>	getResponseReader()	Get a reader that can read a response from a StreamInput.
int	hashCode()
String	name()	The name of the action.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RemoteClusterActionType

public RemoteClusterActionType(String name,
 Writeable.Reader<Response> responseReader)

Construct an ActionType which callers can execute on a remote cluster using a RemoteClusterClient, typically obtained from Client.getRemoteClusterClient(java.lang.String, java.util.concurrent.Executor)).

Parameters:

name - The name of the action, which must be unique across actions. This is the ID of the transport action which is sent to the handling node in the remote cluster.

responseReader - Defines how to deserialize responses received from executions of this action.

Method Details

emptyResponse

public static RemoteClusterActionType<ActionResponse.Empty> emptyResponse(String name)

name

public String name()

The name of the action. Must be unique across actions.

getResponseReader

public Writeable.Reader<Response> getResponseReader()

Get a reader that can read a response from a StreamInput.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object