Package org.opensearch.action
Actions that OpenSearch can take either on the data stored on disk or on other nodes.
-
Interface Summary Interface Description ActionFuture<T> An extension toFutureallowing for simplified "get" operations.ActionListener<Response> A listener for action responses or failures.AliasesRequest Needs to be implemented by allActionRequestsubclasses that relate to one or more indices and one or more aliases.CompositeIndicesRequest Marker interface that needs to be implemented by allActionRequestsubclasses that are composed of multiple sub-requests which relate to one or more indices.DocWriteRequest<T> Generic interface to group ActionRequest, which perform writes to a single document Action requests implementing this can be part ofBulkRequestIndicesRequest Needs to be implemented by allActionRequestsubclasses that relate to one or more indices.IndicesRequest.Replaceable ListenableActionFuture<T> AnActionFuturethat listeners can be added to.RealtimeRequest Indicates that a request can execute in realtime (reads from the translog).RequestValidators.RequestValidator<T extends ActionRequest> A validator that validates an request associated with indices before executing it. -
Class Summary Class Description ActionListenerResponseHandler<Response extends TransportResponse> A simple base class for action response listeners, defaulting to using the SAME executor (as its very common on response handlers).ActionModule Builds and binds the generic action map, allTransportActions, andActionFilters.ActionRequest ActionRequestBuilder<Request extends ActionRequest,Response extends ActionResponse> ActionResponse Base class for responses to action requests.ActionRunnable<Response> Base class forRunnables that need to callActionListener.onFailure(Exception)in case an uncaught exception or error is thrown while the actual action is run.ActionType<Response extends ActionResponse> A generic action.DocWriteResponse A base class for the response of a write operation that involves a single docDocWriteResponse.Builder Base class of allDocWriteResponsebuilders.LatchedActionListener<T> An action listener that allows passing in aCountDownLatchthat will be counted down after onResponse or onFailure is calledNotifyOnceListener<Response> A listener that ensures that only one of onResponse or onFailure is called.OriginalIndices Used to keep track of original indices within internal (e.g.RequestValidators<T extends ActionRequest> ShardOperationFailedException An exception indicating that a failure occurred performing an operation on the shard.StepListener<Response> AStepListenerprovides a simple way to write a flow consisting of multiple asynchronous steps without having nested callbacks.TaskOperationFailure Information about task operation failures The class is final due to serialization limitationsTransportActionNodeProxy<Request extends ActionRequest,Response extends ActionResponse> A generic proxy that will execute the given action against a specific node.ValidateActions -
Enum Summary Enum Description DocWriteRequest.OpType Requested operation type to perform on the documentDocWriteResponse.Result An enum that represents the results of CRUD operations, primarily used to communicate the type of operation that occurred.ThreadingModel