Record Class PlanProfile

java.lang.Object
java.lang.Record
org.elasticsearch.compute.operator.PlanProfile
All Implemented Interfaces:
Writeable, org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject

public record PlanProfile(String description, String clusterName, String nodeName, String planTree) extends Record implements Writeable, org.elasticsearch.xcontent.ToXContentObject
  • Nested Class Summary

    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

    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.xcontent.ToXContent

    EMPTY, EMPTY_PARAMS
  • Constructor Summary

    Constructors
    Constructor
    Description
    PlanProfile(String description, String clusterName, String nodeName, String planTree)
    Creates an instance of a PlanProfile record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    Returns the value of the clusterName record component.
    Returns the value of the description record component.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    Returns the value of the nodeName record component.
    Returns the value of the planTree record component.
     
    final String
    Returns a string representation of this record class.
    org.elasticsearch.xcontent.XContentBuilder
    toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params)
     
    void
     

    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

    • PlanProfile

      public PlanProfile(String description, String clusterName, String nodeName, String planTree)
      Creates an instance of a PlanProfile record class.
      Parameters:
      description - the value for the description record component
      clusterName - the value for the clusterName record component
      nodeName - the value for the nodeName record component
      planTree - the value for the planTree record component
  • Method Details

    • readFrom

      public static PlanProfile readFrom(StreamInput in) throws IOException
      Throws:
      IOException
    • writeTo

      public void writeTo(StreamOutput out) throws IOException
      Specified by:
      writeTo in interface Writeable
      Throws:
      IOException
    • 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.
    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • clusterName

      public String clusterName()
      Returns the value of the clusterName record component.
      Returns:
      the value of the clusterName record component
    • nodeName

      public String nodeName()
      Returns the value of the nodeName record component.
      Returns:
      the value of the nodeName record component
    • planTree

      public String planTree()
      Returns the value of the planTree record component.
      Returns:
      the value of the planTree record component