org.elasticsearch.action

Class ActionRequestBuilder<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>>

java.lang.Object

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

Direct Known Subclasses:

BroadcastOperationRequestBuilder, BulkRequestBuilder, ClearScrollRequestBuilder, DeleteIndexedScriptRequestBuilder, GetFieldMappingsRequestBuilder, GetIndexedScriptRequestBuilder, InstanceShardOperationRequestBuilder, MasterNodeOperationRequestBuilder, MultiGetRequestBuilder, MultiPercolateRequestBuilder, MultiSearchRequestBuilder, MultiTermVectorsRequestBuilder, NodesOperationRequestBuilder, PutIndexedScriptRequestBuilder, RenderSearchTemplateRequestBuilder, ReplicationRequestBuilder, SearchRequestBuilder, SearchScrollRequestBuilder, SingleShardOperationRequestBuilder, SyncedFlushRequestBuilder, TasksRequestBuilder, TermVectorsRequestBuilder

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Action<Request,Response,RequestBuilder>	action
protected ElasticsearchClient	client
protected Request	request

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ActionRequestBuilder(ElasticsearchClient client, Action<Request,Response,RequestBuilder> action, Request request)

Method Summary

Methods

Modifier and Type	Method and Description
protected Request	beforeExecute(Request request) A callback to additionally process the request before its executed
ListenableActionFuture<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(TimeValue timeout) Short version of execute().actionGet().
RequestBuilder	putHeader(String key, Object value)
Request	request()

Methods inherited from class java.lang.Object

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

Field Detail

action

protected final Action<Request extends ActionRequest,Response extends ActionResponse,RequestBuilder extends ActionRequestBuilder<Request,Response,RequestBuilder>> action

request

protected final Request extends ActionRequest request

client

protected final ElasticsearchClient client

Constructor Detail

ActionRequestBuilder

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

Method Detail

request

public Request request()

putHeader

public final RequestBuilder putHeader(String key,
                       Object value)

execute

public ListenableActionFuture<Response> execute()

get

public Response get()

Short version of execute().actionGet().

get

public Response get(TimeValue timeout)

Short version of execute().actionGet().

Parameters:

timeout - Timeout

get

public Response get(String timeout)

Short version of execute().actionGet().

Parameters:

timeout - Timeout

execute

public void execute(ActionListener<Response> listener)

beforeExecute

protected Request beforeExecute(Request request)

A callback to additionally process the request before its executed

Parameters:

request - Request