Record Class ResourceDiagnostics.DigestSection

java.lang.Object
java.lang.Record
com.inductiveautomation.ignition.gateway.config.ResourceDiagnostics.DigestSection
Record Components:
heading - the section heading, shown to the model as a markdown heading.
body - renders the body against the live gateway, or returns null when there is nothing to report.
Enclosing interface:
ResourceDiagnostics

public static record ResourceDiagnostics.DigestSection(String heading, Function<GatewayContext, @Nullable String> body) extends Record
A digest section heading and the function that renders its body, evaluated once per digest request.

Bodies may throw and may return null; either way the section is omitted and the rest of the digest still renders.

  • Constructor Details

    • DigestSection

      public DigestSection(String heading, Function<GatewayContext, @Nullable String> body)
      Creates an instance of a DigestSection record class.
      Parameters:
      heading - the value for the heading record component
      body - the value for the body 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.
    • heading

      public String heading()
      Returns the value of the heading record component.
      Returns:
      the value of the heading record component
    • body

      public Function<GatewayContext, @Nullable String> body()
      Returns the value of the body record component.
      Returns:
      the value of the body record component