Package org.elasticsearch.health

Record Class HealthComponentResult

java.lang.Object
java.lang.Record
org.elasticsearch.health.HealthComponentResult
All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent, org.elasticsearch.xcontent.ToXContentObject
public record HealthComponentResult(String name, HealthStatus status, List<HealthIndicatorResult> indicators) extends Record implements 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

  • Field Summary

    Fields inherited from interface org.elasticsearch.xcontent.ToXContent

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    HealthComponentResult(String name, HealthStatus status, List<HealthIndicatorResult> indicators)
    Creates an instance of a HealthComponentResult record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static Collection<HealthComponentResult>
    createComponentsFromIndicators(Collection<HealthIndicatorResult> indicators)
     
    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.
    List<HealthIndicatorResult>
    indicators()
    Returns the value of the indicators record component.
    String
    name()
    Returns the value of the name record component.
    HealthStatus
    status()
    Returns the value of the status record component.
    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

    • HealthComponentResult

      public HealthComponentResult(String name, HealthStatus status, List<HealthIndicatorResult> indicators)
      Creates an instance of a HealthComponentResult record class.
      Parameters:
      name - the value for the name record component
      status - the value for the status record component
      indicators - the value for the indicators record component

  • Method Details

    • createComponentsFromIndicators

      public static Collection<HealthComponentResult> createComponentsFromIndicators(Collection<HealthIndicatorResult> indicators)

    • 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.

    • name

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

    • status

      public HealthStatus status()
      Returns the value of the status record component.
      Returns:
      the value of the status record component

    • indicators

      public List<HealthIndicatorResult> indicators()
      Returns the value of the indicators record component.
      Returns:
      the value of the indicators record component