Package org.opensearch.action

Class ActionRequestBuilder<Request extends ActionRequest,Response extends ActionResponse>

java.lang.Object

org.opensearch.action.ActionRequestBuilder<Request,Response>

Direct Known Subclasses:

AbstractBulkByScrollRequestBuilder, BroadcastOperationRequestBuilder, BulkRequestBuilder, ClearScrollRequestBuilder, ClusterManagerNodeOperationRequestBuilder, DeletePipelineRequestBuilder, FieldCapabilitiesRequestBuilder, GetFieldMappingsRequestBuilder, GetTaskRequestBuilder, InstanceShardOperationRequestBuilder, MainRequestBuilder, MultiGetRequestBuilder, MultiSearchRequestBuilder, MultiTermVectorsRequestBuilder, NodesOperationRequestBuilder, PutPipelineRequestBuilder, RemoteInfoRequestBuilder, ReplicationRequestBuilder, SearchRequestBuilder, SearchScrollRequestBuilder, SimulatePipelineRequestBuilder, SingleShardOperationRequestBuilder, TasksRequestBuilder, TermVectorsRequestBuilder

public abstract class ActionRequestBuilder<Request extends ActionRequest,Response extends ActionResponse>
extends Object

Base Action Request Builder

Opensearch.internal:

Field Summary

Fields

Modifier and Type	Field	Description
protected final ActionType<Response>	action
protected final OpenSearchClient	client
protected final Request	request

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActionRequestBuilder(OpenSearchClient client, ActionType<Response> action, Request request)

Method Summary

Modifier and Type	Method	Description
ActionFuture<Response>	execute()
void	execute(ActionListener<Response> listener)
Response	get()	Short version of execute().actionGet().
Response	get(String timeout)	Short version of execute().actionGet().
Response	get(org.opensearch.common.unit.TimeValue timeout)	Short version of execute().actionGet().
Request	request()

Methods inherited from class java.lang.Object

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

Field Details

action

protected final ActionType<Response extends ActionResponse> action

request

protected final Request extends ActionRequest request

client

protected final OpenSearchClient client

Constructor Details

ActionRequestBuilder

protected ActionRequestBuilder(OpenSearchClient client,
 ActionType<Response> action,
 Request request)

Method Details

request

public Request request()

execute

public ActionFuture<Response> execute()

get

public Response get()

Short version of execute().actionGet().

get

public Response get(org.opensearch.common.unit.TimeValue timeout)

Short version of execute().actionGet().

get

public Response get(String timeout)

Short version of execute().actionGet().

execute

public void execute(ActionListener<Response> listener)