Record Class EventPreview.Success
java.lang.Object
java.lang.Record
com.inductiveautomation.eventstream.EventPreview.Success
- Record Components:
encoderTypeId- type id of the encoder that was used to encode the data covered byencoded.encoded- the encoded data rendered as text: rawbyte[]output is Base64-encoded, everything else is its string form.metadata- the encoded event's metadata as a JSON tree — the same content carried byEventPayload.getMetadata(), in its wire shape.
- All Implemented Interfaces:
EventPreview
- Enclosing interface:
EventPreview
public static record EventPreview.Success(String encoderTypeId, String encoded, com.inductiveautomation.ignition.common.gson.JsonObject metadata)
extends Record
implements EventPreview
A successfully encoded event.
-
Nested Class Summary
Nested classes/interfaces inherited from interface EventPreview
EventPreview.Failure, EventPreview.GsonAdapter, EventPreview.Success -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionencoded()Returns the value of theencodedrecord component.Returns the value of theencoderTypeIdrecord component.final booleanIndicates whether some other object is "equal to" this one.final inthashCode()Returns a hash code value for this object.com.inductiveautomation.ignition.common.gson.JsonObjectmetadata()Returns the value of themetadatarecord component.final StringtoString()Returns a string representation of this record class.
-
Constructor Details
-
Success
public Success(String encoderTypeId, String encoded, com.inductiveautomation.ignition.common.gson.JsonObject metadata) Creates an instance of aSuccessrecord class.- Parameters:
encoderTypeId- the value for theencoderTypeIdrecord componentencoded- the value for theencodedrecord componentmetadata- the value for themetadatarecord 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. All components in this record class are compared withObjects::equals(Object,Object). -
encoderTypeId
Returns the value of theencoderTypeIdrecord component.- Returns:
- the value of the
encoderTypeIdrecord component
-
encoded
-
metadata
-