Record Class GatewayOnlyParams
java.lang.Object
java.lang.Record
com.inductiveautomation.historian.common.model.options.GatewayOnlyParams
- All Implemented Interfaces:
AggregateParams
Sentinel
recordType of a ParameterSchema decoded where the original params class
is unavailable, such as the designer decoding a gateway-specific type like
StatsAggParams. The schema's ParameterSchema.fields() stay intact.
Callers that only read ParameterSchema.fields(), such as UI rendering, are unaffected.
ParameterSchema.fromMap(Map), ParameterSchema.fromMapWithDefaults(Map) and ParameterSchema.validateRecord(AggregateParams) are gateway-side only and must not be called on a schema carrying
this sentinel.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of aGatewayOnlyParamsrecord class. -
Method Summary
Modifier and TypeMethodDescriptionfinal booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.toMap()Returns the parameters as a JSON-friendly map, for wire transport and catalog metadata.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
GatewayOnlyParams
public GatewayOnlyParams()Creates an instance of aGatewayOnlyParamsrecord class.
-
-
Method Details
-
toMap
Description copied from interface:AggregateParamsReturns the parameters as a JSON-friendly map, for wire transport and catalog metadata.- Specified by:
toMapin interfaceAggregateParams- Returns:
- the parameters by component name.
-
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.
-