GetTaskRequest (server 7.6.2 API)

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:: 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()
Get the TaskId to look up.

GetTaskRequest(StreamInput in)

Method Summary

Modifier and Type	Method	Description
`TaskId`	`getTaskId()`
`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?
`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 into the StreamOutput.

Methods inherited from class org.elasticsearch.action.ActionRequest

getShouldStoreResult

Methods inherited from class org.elasticsearch.transport.TransportRequest

getParentTask, setParentTask

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.tasks.TaskAwareRequest

createTask, getDescription, setParentTask

Constructor Details
- GetTaskRequest
  
  public GetTaskRequest()
  
  Get the TaskId to look up.
- GetTaskRequest
  
  public GetTaskRequest(StreamInput in) throws java.io.IOException
  
  Throws:
  
  java.io.IOException
Method Details
- getTaskId
  
  public TaskId getTaskId()
- 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
- writeTo
  
  public void writeTo(StreamOutput out) throws java.io.IOException
  
  Description copied from interface: Writeable
  
  Write this into the StreamOutput.
  
  Specified by:
  
  writeTo in interface Writeable
  
  Overrides:
  
  writeTo in class ActionRequest
  
  Throws:
  
  java.io.IOException