Record Class CheckResponse

java.lang.Object
java.lang.Record
com.pain001.sdk.CheckResponse
Record Components:
messageType - the detected message type
passed - whether no rung reported an error
errors - the number of error findings
warnings - the number of warning findings
rungs - the rungs that ran, in order
findings - every finding

public record CheckResponse(String messageType, boolean passed, int errors, int warnings, List<String> rungs, List<CheckFinding> findings) extends Record
POST /api/v1/check: the verdict, the rungs that ran and every finding.
  • Constructor Details

    • CheckResponse

      public CheckResponse(String messageType, boolean passed, int errors, int warnings, List<String> rungs, List<CheckFinding> findings)
      Copies the lists so the record stays immutable.
  • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • messageType

      public String messageType()
      Returns the value of the messageType record component.
      Returns:
      the value of the messageType record component
    • passed

      public boolean passed()
      Returns the value of the passed record component.
      Returns:
      the value of the passed record component
    • errors

      public int errors()
      Returns the value of the errors record component.
      Returns:
      the value of the errors record component
    • warnings

      public int warnings()
      Returns the value of the warnings record component.
      Returns:
      the value of the warnings record component
    • rungs

      public List<String> rungs()
      Returns the value of the rungs record component.
      Returns:
      the value of the rungs record component
    • findings

      public List<CheckFinding> findings()
      Returns the value of the findings record component.
      Returns:
      the value of the findings record component