Module org.elasticsearch.server

Package org.elasticsearch.action

Class ActionRequestBuilder<Request extends ActionRequest,Response extends ActionResponse>

java.lang.Object

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

All Implemented Interfaces:

RequestBuilder<Request,Response>

Direct Known Subclasses:

BroadcastOperationRequestBuilder, ClearScrollRequestBuilder, DeletePipelineRequestBuilder, FieldCapabilitiesRequestBuilder, GetFieldMappingsRequestBuilder, GetTaskRequestBuilder, MasterNodeOperationRequestBuilder, MultiGetRequestBuilder, MultiSearchRequestBuilder, MultiTermVectorsRequestBuilder, NodesOperationRequestBuilder, PutPipelineRequestBuilder, SearchRequestBuilder, SearchScrollRequestBuilder, SimulatePipelineRequestBuilder, SingleShardOperationRequestBuilder, TasksRequestBuilder, TermVectorsRequestBuilder

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ActionRequestBuilder(ElasticsearchClient 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(TimeValue timeout)	Short version of execute().actionGet().
Request	request()	This method returns the request that this builder builds.

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 ElasticsearchClient client

Constructor Details

ActionRequestBuilder

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

Method Details

request

public Request request()

Description copied from interface: RequestBuilder

This method returns the request that this builder builds. Depending on the implementation, it might return a new request with each call or the same request with each call.

Specified by:

request in interface RequestBuilder<Request extends ActionRequest,Response extends ActionResponse>

execute

public ActionFuture<Response> execute()

Specified by:

execute in interface RequestBuilder<Request extends ActionRequest,Response extends ActionResponse>

get

public Response get()

Short version of execute().actionGet().

Specified by:

get in interface RequestBuilder<Request extends ActionRequest,Response extends ActionResponse>

get

public Response get(TimeValue timeout)

Short version of execute().actionGet().

Specified by:

get in interface RequestBuilder<Request extends ActionRequest,Response extends ActionResponse>

execute

public void execute(ActionListener<Response> listener)

Specified by:

execute in interface RequestBuilder<Request extends ActionRequest,Response extends ActionResponse>