Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.async

Interface AsyncTask

All Known Implementing Classes:

StoredAsyncTask

public interface AsyncTask

A task that supports asynchronous execution and provides information necessary for safe temporary storage of results

Field Summary

Fields

Modifier and Type	Field	Description
static final TransportVersion	ASYNC_TASK_KEEP_ALIVE_STATUS	Transport version that added keep_alive to async task status payloads.

Method Summary

Modifier and Type	Method	Description
void	cancelTask(TaskManager taskManager, Runnable runnable, String reason)	Performs necessary checks, cancels the task and calls the runnable upon completion
AsyncExecutionId	getExecutionId()	Returns the AsyncExecutionId of the task
org.elasticsearch.core.TimeValue	getKeepAlive()	Returns the currently effective keep-alive for this task.
Map<String,String>	getOriginHeaders()	Returns all of the request contexts headers
boolean	isCancelled()	Returns true if the task is cancelled
void	setExpirationTime(long expirationTimeMillis, org.elasticsearch.core.TimeValue keepAlive)	Update the expiration time of the (partial) response.

Field Details

ASYNC_TASK_KEEP_ALIVE_STATUS

static final TransportVersion ASYNC_TASK_KEEP_ALIVE_STATUS

Transport version that added keep_alive to async task status payloads.

Method Details

getOriginHeaders

Map<String,String> getOriginHeaders()

Returns all of the request contexts headers

getExecutionId

AsyncExecutionId getExecutionId()

Returns the AsyncExecutionId of the task

isCancelled

boolean isCancelled()

Returns true if the task is cancelled

setExpirationTime

void setExpirationTime(long expirationTimeMillis,
 org.elasticsearch.core.TimeValue keepAlive)

Update the expiration time of the (partial) response.

getKeepAlive

org.elasticsearch.core.TimeValue getKeepAlive()

Returns the currently effective keep-alive for this task.

cancelTask

void cancelTask(TaskManager taskManager,
 Runnable runnable,
 String reason)

Performs necessary checks, cancels the task and calls the runnable upon completion