Record Class AuditEvent

java.lang.Object
java.lang.Record
ai.doctruth.spi.AuditEvent
public record AuditEvent(String kind, Instant at, Map<String,String> attributes) extends Record
A single audit event emitted by the library — extraction success, extraction failure, citation-below-threshold, etc. attributes is an open map for SIEM-side categorisation (provider name, retry count, error code, field path).

kind convention: "<domain>.<verb>" — e.g. "extraction.success", "extraction.failed", "citation.below_threshold".

Invariants: kind non-null and non-blank; at non-null; attributes non-null (empty map allowed).

Since:
0.1.0

  • Constructor Details

    • AuditEvent

      public AuditEvent(String kind, Instant at, Map<String,String> attributes)
      Creates an instance of a AuditEvent record class.
      Parameters:
      kind - the value for the kind record component
      at - the value for the at record component
      attributes - the value for the attributes 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.

    • kind

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

    • at

      public Instant at()
      Returns the value of the at record component.
      Returns:
      the value of the at record component

    • attributes

      public Map<String,String> attributes()
      Returns the value of the attributes record component.
      Returns:
      the value of the attributes record component