Record Class DiagnosticDigestSummary

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.ai.DiagnosticDigestSummary

public record DiagnosticDigestSummary(String summary, DiagnosticDigestSummary.HealthStatus status) extends Record
Result record produced by the page-load summary flow of the diagnostic-digest feature. Carries the one-or-two-sentence health blurb that the front-end renders next to a green/red status pip, plus the stoplight-style judgment itself.

This is the typed counterpart to DiagnosticDigestAnalysis: where the summary is cheap to produce and shown immediately, the analysis is gated behind an operator click. Both are typed via AgenticHarness.send(String, Class<T>).

  • Constructor Details

    • DiagnosticDigestSummary

      public DiagnosticDigestSummary(String summary, DiagnosticDigestSummary.HealthStatus status)
      Creates an instance of a DiagnosticDigestSummary record class.
      Parameters:
      summary - the value for the summary record component
      status - the value for the status record component
  • Method Details

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

      public String summary()
      Returns the value of the summary record component.
      Returns:
      the value of the summary record component
    • status

      Returns the value of the status record component.
      Returns:
      the value of the status record component