Package org.elasticsearch.action.admin.cluster.node.tasks.get

Class GetTaskRequest

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportRequest

org.elasticsearch.action.ActionRequest

org.elasticsearch.action.admin.cluster.node.tasks.get.GetTaskRequest

All Implemented Interfaces:

Streamable, Writeable, TaskAwareRequest

public class GetTaskRequest
extends ActionRequest

A request to get node tasks

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.transport.TransportRequest

TransportRequest.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Constructor Summary

Constructors

Constructor	Description
GetTaskRequest()

Method Summary

Modifier and Type	Method	Description
TaskId	getTaskId()	Get the TaskId to look up.
TimeValue	getTimeout()	Timeout to wait for any async actions this request must take.
boolean	getWaitForCompletion()	Should this request wait for all found tasks to complete?
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
GetTaskRequest	setTaskId(TaskId taskId)	Set the TaskId to look up.
GetTaskRequest	setTimeout(TimeValue timeout)	Timeout to wait for any async actions this request must take.
GetTaskRequest	setWaitForCompletion(boolean waitForCompletion)	Should this request wait for all found tasks to complete?
ActionRequestValidationException	validate()
void	writeTo(StreamOutput out)	Write this object's fields to a StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.io.stream.Streamable

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Constructor Detail

GetTaskRequest

public GetTaskRequest()

Method Detail

getTaskId

public TaskId getTaskId()

Get the TaskId to look up.

setTaskId

public GetTaskRequest setTaskId(TaskId taskId)

Set the TaskId to look up. Required.

getWaitForCompletion

public boolean getWaitForCompletion()

Should this request wait for all found tasks to complete?

setWaitForCompletion

public GetTaskRequest setWaitForCompletion(boolean waitForCompletion)

Should this request wait for all found tasks to complete?

getTimeout

public TimeValue getTimeout()

Timeout to wait for any async actions this request must take. It must take anywhere from 0 to 2.

setTimeout

public GetTaskRequest setTimeout(TimeValue timeout)

Timeout to wait for any async actions this request must take. It must take anywhere from 0 to 2.

validate

public ActionRequestValidationException validate()

Specified by:

validate in class ActionRequest

readFrom

public void readFrom(StreamInput in)
              throws java.io.IOException

Description copied from interface: Streamable

Set this object's fields from a StreamInput.

Specified by:

readFrom in interface Streamable

Overrides:

readFrom in class ActionRequest

Throws:

java.io.IOException

writeTo

public void writeTo(StreamOutput out)
             throws java.io.IOException

Description copied from interface: Streamable

Write this object's fields to a StreamOutput.

Specified by:

writeTo in interface Streamable

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class ActionRequest

Throws:

java.io.IOException