Package com.inductiveautomation.ignition.gateway.storeforward.quarantine

Record Class QuarantinedDataInfo

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.storeforward.quarantine.QuarantinedDataInfo

Record Components:

id - the id for the data represented by this quarantined data info

dataCount - the total number of quarantined data contained within

description - the description indicating what the associated quarantined data represents

quarantineReason - the failure message related to why this data was quarantined

flavor - the relevant data flavor for the data quarantined

public record QuarantinedDataInfo(int id, int dataCount, String description, String quarantineReason, PersistentFlavor<?> flavor, String quarantineInterfaceId)
extends Record

Represents the information associated for any quarantined data.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QuarantinedDataInfo.Builder
static class	QuarantinedDataInfo.QuarantinedDataInfoSerializer<T extends QuarantinedDataInfo>

Constructor Summary

Constructors

Constructor	Description
QuarantinedDataInfo(int id, int dataCount, String description, String quarantineReason, PersistentFlavor<?> flavor)	Convenience constructor that defaults quarantineInterfaceId to empty string.
QuarantinedDataInfo(int id, int dataCount, String description, String quarantineReason, PersistentFlavor<?> flavor, String quarantineInterfaceId)	Canonical constructor that validates required fields and ensures quarantineInterfaceId is never null.

Method Summary

Modifier and Type	Method	Description
int	dataCount()	Returns the value of the dataCount record component.
String	description()	Returns the value of the description record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
PersistentFlavor<?>	flavor()	Returns the value of the flavor record component.
final int	hashCode()	Returns a hash code value for this object.
int	id()	Returns the value of the id record component.
static QuarantinedDataInfo.Builder	newBuilder()
static QuarantinedDataInfo.Builder	newBuilder(QuarantinedDataInfo quarantinedDataInfo)
String	quarantineInterfaceId()	Returns the value of the quarantineInterfaceId record component.
String	quarantineReason()	Returns the value of the quarantineReason record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

QuarantinedDataInfo

public QuarantinedDataInfo(int id,
 int dataCount,
 String description,
 String quarantineReason,
 PersistentFlavor<?> flavor,
 String quarantineInterfaceId)

Canonical constructor that validates required fields and ensures quarantineInterfaceId is never null.

QuarantinedDataInfo

public QuarantinedDataInfo(int id,
 int dataCount,
 String description,
 String quarantineReason,
 PersistentFlavor<?> flavor)

Convenience constructor that defaults quarantineInterfaceId to empty string.

Method Details

newBuilder

public static QuarantinedDataInfo.Builder newBuilder()

newBuilder

public static QuarantinedDataInfo.Builder newBuilder(QuarantinedDataInfo quarantinedDataInfo)

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 '=='.

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.

id

public int id()

Returns the value of the id record component.

Returns:

the value of the id record component

dataCount

public int dataCount()

Returns the value of the dataCount record component.

Returns:

the value of the dataCount record component

description

public String description()

Returns the value of the description record component.

Returns:

the value of the description record component

quarantineReason

public String quarantineReason()

Returns the value of the quarantineReason record component.

Returns:

the value of the quarantineReason record component

flavor

public PersistentFlavor<?> flavor()

Returns the value of the flavor record component.

Returns:

the value of the flavor record component

quarantineInterfaceId

public String quarantineInterfaceId()

Returns the value of the quarantineInterfaceId record component.

Returns:

the value of the quarantineInterfaceId record component