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

Record Class TaskGroup

java.lang.Object
java.lang.Record
org.elasticsearch.action.admin.cluster.node.tasks.list.TaskGroup
All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public record TaskGroup(TaskInfo task, List<TaskGroup> childTasks) extends Record implements org.elasticsearch.xcontent.ToXContentObject
Information about a currently running task and all its subtasks.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    TaskGroup.Builder
     

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

    org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params

  • Field Summary

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    TaskGroup(TaskInfo task, List<TaskGroup> childTasks)
    Creates an instance of a TaskGroup record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static TaskGroup.Builder
    builder(TaskInfo taskInfo)
     
    List<TaskGroup>
    childTasks()
    Returns the value of the childTasks record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    TaskInfo
    task()
    Returns the value of the task record component.
    TaskInfo
    taskInfo()
     
    final String
    toString()
    Returns a string representation of this record class.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     

    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

    • TaskGroup

      public TaskGroup(TaskInfo task, List<TaskGroup> childTasks)
      Creates an instance of a TaskGroup record class.
      Parameters:
      task - the value for the task record component
      childTasks - the value for the childTasks record component

  • Method Details

    • builder

      public static TaskGroup.Builder builder(TaskInfo taskInfo)

    • taskInfo

      public TaskInfo taskInfo()

    • toXContent

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

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • task

      public TaskInfo task()
      Returns the value of the task record component.
      Returns:
      the value of the task record component

    • childTasks

      public List<TaskGroup> childTasks()
      Returns the value of the childTasks record component.
      Returns:
      the value of the childTasks record component