Record Class HistorianQueryEntry.AnnotationEntry

java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.binding.HistorianQueryEntry.AnnotationEntry
All Implemented Interfaces:
HistorianQueryEntry
Enclosing interface:
HistorianQueryEntry

public static record HistorianQueryEntry.AnnotationEntry(String alias, QualifiedPath source, AnnotationFilter filter, boolean appendOnly) extends Record implements HistorianQueryEntry
Annotation entry: filters by AnnotationFilter on author and type, with no aggregation. The filter is never null; pass AnnotationFilter.ALL for no filtering. In JSON, an object with optional authors and types arrays; a missing or empty array leaves that axis unconstrained.
  • Constructor Details

    • AnnotationEntry

      public AnnotationEntry(String alias, QualifiedPath source, AnnotationFilter filter, boolean appendOnly)
      Creates an instance of a AnnotationEntry record class.
      Parameters:
      alias - the value for the alias record component
      source - the value for the source record component
      filter - the value for the filter record component
      appendOnly - the value for the appendOnly 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      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.
    • alias

      public String alias()
      Returns the value of the alias record component.
      Specified by:
      alias in interface HistorianQueryEntry
      Returns:
      the value of the alias record component
    • source

      public QualifiedPath source()
      Returns the value of the source record component.
      Specified by:
      source in interface HistorianQueryEntry
      Returns:
      the value of the source record component
    • filter

      public AnnotationFilter filter()
      Returns the value of the filter record component.
      Returns:
      the value of the filter record component
    • appendOnly

      public boolean appendOnly()
      Returns the value of the appendOnly record component.
      Specified by:
      appendOnly in interface HistorianQueryEntry
      Returns:
      the value of the appendOnly record component