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

Class ListTasksResponse

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, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, org.elasticsearch.core.RefCounted
Direct Known Subclasses:
CancelTasksResponse
public class ListTasksResponse extends BaseTasksResponse implements org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent

    org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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.common.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

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

  • Method Summary

    Modifier and Type
    Method
    Description
    static ListTasksResponse
    fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
     
    <,​<TaskInfo>>
    getPerNodeTasks()
    Returns the list of tasks by node
    <TaskGroup>
    getTaskGroups()
    Get the tasks found by this request grouped by parent tasks.
    <TaskInfo>
    getTasks()
    Get the tasks found by this request.
    protected static <T> org.elasticsearch.common.xcontent.ConstructingObjectParser<T,​>
     name, <<<ElasticsearchException>,​T> ctor)
     
    toString()
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
     
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContentGroupedByNode​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params, DiscoveryNodes discoveryNodes)
    Convert this task response to XContent grouping by executing nodes.
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContentGroupedByNone​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
    Presents a flat list of tasks
    org.elasticsearch.common.xcontent.XContentBuilder
    toXContentGroupedByParents​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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, incRef, remoteAddress, remoteAddress, tryIncRef

    Methods inherited from class java.lang.

    , , , , , , ,

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

    isFragment

  • Constructor Details

  • Method Details

    • writeTo

      public void writeTo​(StreamOutput out) throws
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Overrides:
      writeTo in class BaseTasksResponse
      Throws:

    • setupParser

      protected static <T> org.elasticsearch.common.xcontent.ConstructingObjectParser<T,​> setupParser​( name, <<<ElasticsearchException>,​T> ctor)

    • getPerNodeTasks

      public <,​<TaskInfo>> getPerNodeTasks()
      Returns the list of tasks by node

    • getTaskGroups

      public <TaskGroup> getTaskGroups()
      Get the tasks found by this request grouped by parent tasks.

    • getTasks

      public <TaskInfo> getTasks()
      Get the tasks found by this request.

    • toXContentGroupedByNode

      public org.elasticsearch.common.xcontent.XContentBuilder toXContentGroupedByNode​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params, DiscoveryNodes discoveryNodes) throws
      Convert this task response to XContent grouping by executing nodes.
      Throws:

    • toXContentGroupedByParents

      public org.elasticsearch.common.xcontent.XContentBuilder toXContentGroupedByParents​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Convert this response to XContent grouping by parent tasks.
      Throws:

    • toXContentGroupedByNone

      public org.elasticsearch.common.xcontent.XContentBuilder toXContentGroupedByNone​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Presents a flat list of tasks
      Throws:

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:

    • fromXContent

      public static ListTasksResponse fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)

    • toString

      public  toString()
      Overrides:
       in class