Module org.elasticsearch.server

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

Class ListTasksResponse

java.lang.Object

org.elasticsearch.transport.TransportMessage

org.elasticsearch.transport.TransportResponse

org.elasticsearch.action.ActionResponse

org.elasticsearch.action.support.tasks.BaseTasksResponse

org.elasticsearch.action.admin.cluster.node.tasks.list.ListTasksResponse

All Implemented Interfaces:

Writeable, RefCounted, ToXContent, ToXContentObject

Direct Known Subclasses:

CancelTasksResponse

public class ListTasksResponse
extends BaseTasksResponse
implements ToXContentObject

Returns the list of tasks currently running on the nodes

Nested Class Summary

Nested classes/interfaces inherited from class org.elasticsearch.action.ActionResponse

ActionResponse.Empty

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

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

Field Summary

Fields inherited from class org.elasticsearch.action.support.tasks.BaseTasksResponse

NODE_FAILURES, TASK_FAILURES

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ListTasksResponse(List<TaskInfo> tasks, List<TaskOperationFailure> taskFailures, List<? extends ElasticsearchException> nodeFailures)
ListTasksResponse(StreamInput in)

Method Summary

Modifier and Type	Method	Description
static ListTasksResponse	fromXContent(XContentParser parser)
Map<String,List<TaskInfo>>	getPerNodeTasks()	Returns the list of tasks by node
List<TaskGroup>	getTaskGroups()	Get the tasks found by this request grouped by parent tasks.
List<TaskInfo>	getTasks()	Get the tasks found by this request.
protected static <T> ConstructingObjectParser<T,Void>	setupParser(String name, TriFunction<List<TaskInfo>,List<TaskOperationFailure>,List<ElasticsearchException>,T> ctor)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
XContentBuilder	toXContentGroupedByNode(XContentBuilder builder, ToXContent.Params params, DiscoveryNodes discoveryNodes)	Convert this task response to XContent grouping by executing nodes.
XContentBuilder	toXContentGroupedByNone(XContentBuilder builder, ToXContent.Params params)	Presents a flat list of tasks
XContentBuilder	toXContentGroupedByParents(XContentBuilder builder, ToXContent.Params params)	Convert this response to XContent grouping by parent tasks.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class org.elasticsearch.action.support.tasks.BaseTasksResponse

equals, getNodeFailures, getTaskFailures, hashCode, rethrowFailures, toXContentCommon

Methods inherited from class org.elasticsearch.transport.TransportMessage

decRef, hasReferences, incRef, remoteAddress, remoteAddress, tryIncRef

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Constructor Details

ListTasksResponse

public ListTasksResponse(List<TaskInfo> tasks,
 List<TaskOperationFailure> taskFailures,
 List<? extends ElasticsearchException> nodeFailures)

ListTasksResponse

public ListTasksResponse(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Overrides:

writeTo in class BaseTasksResponse

Throws:

IOException

setupParser

protected static <T>
ConstructingObjectParser<T,Void> setupParser(String name,
 TriFunction<List<TaskInfo>,List<TaskOperationFailure>,List<ElasticsearchException>,T> ctor)

getPerNodeTasks

public Map<String,List<TaskInfo>> getPerNodeTasks()

Returns the list of tasks by node

getTaskGroups

public List<TaskGroup> getTaskGroups()

Get the tasks found by this request grouped by parent tasks.

getTasks

public List<TaskInfo> getTasks()

Get the tasks found by this request.

toXContentGroupedByNode

public XContentBuilder toXContentGroupedByNode(XContentBuilder builder,
 ToXContent.Params params,
 DiscoveryNodes discoveryNodes)
                                        throws IOException

Convert this task response to XContent grouping by executing nodes.

Throws:

IOException

toXContentGroupedByParents

public XContentBuilder toXContentGroupedByParents(XContentBuilder builder,
 ToXContent.Params params)
                                           throws IOException

Convert this response to XContent grouping by parent tasks.

Throws:

IOException

toXContentGroupedByNone

public XContentBuilder toXContentGroupedByNone(XContentBuilder builder,
 ToXContent.Params params)
                                        throws IOException

Presents a flat list of tasks

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static ListTasksResponse fromXContent(XContentParser parser)

toString

public String toString()

Overrides:

toString in class Object