Module org.elasticsearch.server
Package org.elasticsearch.health

Record Class HealthIndicatorResult

java.lang.Object
java.lang.Record
org.elasticsearch.health.HealthIndicatorResult
All Implemented Interfaces:
ChunkedToXContent, ChunkedToXContentObject
public record HealthIndicatorResult(String name, HealthStatus status, String symptom, HealthIndicatorDetails details, List<HealthIndicatorImpact> impacts, List<Diagnosis> diagnosisList) extends Record implements ChunkedToXContentObject

  • Constructor Details

    • HealthIndicatorResult

      public HealthIndicatorResult(String name, HealthStatus status, String symptom, HealthIndicatorDetails details, List<HealthIndicatorImpact> impacts, List<Diagnosis> diagnosisList)
      Creates an instance of a HealthIndicatorResult record class.
      Parameters:
      name - the value for the name record component
      status - the value for the status record component
      symptom - the value for the symptom record component
      details - the value for the details record component
      impacts - the value for the impacts record component
      diagnosisList - the value for the diagnosisList record component

  • Method Details

    • toXContentChunked

      public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params outerParams)
      Description copied from interface: ChunkedToXContent
      Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

      Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

      Specified by:
      toXContentChunked in interface ChunkedToXContent
      Returns:
      iterator over chunks of ToXContent

    • 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

    • symptom

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

    • details

      public HealthIndicatorDetails details()
      Returns the value of the details record component.
      Returns:
      the value of the details record component

    • impacts

      public List<HealthIndicatorImpact> impacts()
      Returns the value of the impacts record component.
      Returns:
      the value of the impacts record component

    • diagnosisList

      public List<Diagnosis> diagnosisList()
      Returns the value of the diagnosisList record component.
      Returns:
      the value of the diagnosisList record component