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.-
Nested Class Summary
Nested classes/interfaces inherited from interface HistorianQueryEntry
HistorianQueryEntry.AggregatedEntry, HistorianQueryEntry.AnnotationEntry, HistorianQueryEntry.MetadataEntry, HistorianQueryEntry.RawEntry -
Constructor Summary
ConstructorsConstructorDescriptionAnnotationEntry(String alias, QualifiedPath source, AnnotationFilter filter, boolean appendOnly) Creates an instance of aAnnotationEntryrecord class. -
Method Summary
Modifier and TypeMethodDescriptionalias()Returns the value of thealiasrecord component.booleanReturns the value of theappendOnlyrecord component.final booleanIndicates whether some other object is "equal to" this one.filter()Returns the value of thefilterrecord component.final inthashCode()Returns a hash code value for this object.source()Returns the value of thesourcerecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
AnnotationEntry
public AnnotationEntry(String alias, QualifiedPath source, AnnotationFilter filter, boolean appendOnly) Creates an instance of aAnnotationEntryrecord class.- Parameters:
alias- the value for thealiasrecord componentsource- the value for thesourcerecord componentfilter- the value for thefilterrecord componentappendOnly- the value for theappendOnlyrecord component
-
-
Method Details
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
alias
Returns the value of thealiasrecord component.- Specified by:
aliasin interfaceHistorianQueryEntry- Returns:
- the value of the
aliasrecord component
-
source
Returns the value of thesourcerecord component.- Specified by:
sourcein interfaceHistorianQueryEntry- Returns:
- the value of the
sourcerecord component
-
filter
Returns the value of thefilterrecord component.- Returns:
- the value of the
filterrecord component
-
appendOnly
public boolean appendOnly()Returns the value of theappendOnlyrecord component.- Specified by:
appendOnlyin interfaceHistorianQueryEntry- Returns:
- the value of the
appendOnlyrecord component
-