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:

Streamable, Writeable, 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 interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

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

TransportResponse.Empty

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

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

Field Summary

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ListTasksResponse()
ListTasksResponse(java.util.List<TaskInfo> tasks, java.util.List<TaskOperationFailure> taskFailures, java.util.List<? extends FailedNodeException> nodeFailures)

Method Summary

Modifier and Type	Method	Description
java.util.Map<java.lang.String,java.util.List<TaskInfo>>	getPerNodeTasks()	Returns the list of tasks by node
java.util.List<TaskGroup>	getTaskGroups()	Get the tasks found by this request grouped by parent tasks.
java.util.List<TaskInfo>	getTasks()	Get the tasks found by this request.
void	readFrom(StreamInput in)	Set this object's fields from a StreamInput.
java.lang.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 object's fields to a StreamOutput.

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

getNodeFailures, getTaskFailures, rethrowFailures

Methods inherited from class java.lang.Object

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

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

newWriteableReader

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from class org.elasticsearch.transport.TransportMessage

remoteAddress, remoteAddress

Constructor Detail

ListTasksResponse

public ListTasksResponse()

ListTasksResponse

public ListTasksResponse(java.util.List<TaskInfo> tasks,
                         java.util.List<TaskOperationFailure> taskFailures,
                         java.util.List<? extends FailedNodeException> nodeFailures)

Method Detail

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 BaseTasksResponse

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 BaseTasksResponse

Throws:

java.io.IOException

getPerNodeTasks

public java.util.Map<java.lang.String,java.util.List<TaskInfo>> getPerNodeTasks()

Returns the list of tasks by node

getTaskGroups

public java.util.List<TaskGroup> getTaskGroups()

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

getTasks

public java.util.List<TaskInfo> getTasks()

Get the tasks found by this request.

toXContentGroupedByNode

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

Convert this task response to XContent grouping by executing nodes.

Throws:

java.io.IOException

toXContentGroupedByParents

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

Convert this response to XContent grouping by parent tasks.

Throws:

java.io.IOException

toXContentGroupedByNone

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

Presents a flat list of tasks

Throws:

java.io.IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object