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

Record Class Diagnosis

java.lang.Object
java.lang.Record
org.elasticsearch.health.Diagnosis
Record Components:
definition - The definition of the diagnosis (e.g. message, helpURL)
affectedResources - Optional list of "things" that are affected by this condition (e.g. shards, indices, or policies).
All Implemented Interfaces:
ChunkedToXContent
public record Diagnosis(Diagnosis.Definition definition, List<Diagnosis.Resource> affectedResources) extends Record implements ChunkedToXContent
Details a potential issue that was diagnosed by a HealthService.

  • Constructor Details

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

    • definition

      public Diagnosis.Definition definition()
      Returns the value of the definition record component.
      Returns:
      the value of the definition record component

    • affectedResources

      @Nullable public List<Diagnosis.Resource> affectedResources()
      Returns the value of the affectedResources record component.
      Returns:
      the value of the affectedResources record component