Package com.inductiveautomation.ignition.gateway.storeforward

Record Class SinkLifecycleEvent.SinkRenamed

java.lang.Object

java.lang.Record

com.inductiveautomation.ignition.gateway.storeforward.SinkLifecycleEvent.SinkRenamed

Record Components:

oldStorageKey - the storage key containing the engine ID and old sink ID

newSinkId - the new sink ID

flavor - the flavor identifying which pipelines are affected by this rename

All Implemented Interfaces:

SinkLifecycleEvent

Enclosing interface:

SinkLifecycleEvent

public static record SinkLifecycleEvent.SinkRenamed(StorageKey oldStorageKey, String newSinkId, PersistentFlavor<?> flavor)
extends Record
implements SinkLifecycleEvent

Event indicating that a sink has been renamed. The rename is scoped to pipelines matching the specified flavor.

Nested Class Summary

Nested classes/interfaces inherited from interface com.inductiveautomation.ignition.gateway.storeforward.SinkLifecycleEvent

SinkLifecycleEvent.SinkRenamed

Constructor Summary

Constructors

Constructor	Description
SinkRenamed(StorageKey oldStorageKey, String newSinkId, PersistentFlavor<?> flavor)	Validates all parameters are non-null and newSinkId is not blank.

Method Summary

Modifier and Type	Method	Description
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.
String	newSinkId()	Returns the value of the newSinkId record component.
StorageKey	oldStorageKey()	Returns the value of the oldStorageKey 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

SinkRenamed

public SinkRenamed(StorageKey oldStorageKey,
 String newSinkId,
 PersistentFlavor<?> flavor)

Validates all parameters are non-null and newSinkId is not blank.

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. All components in this record class are compared with Objects::equals(Object,Object).

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.

oldStorageKey

public StorageKey oldStorageKey()

Returns the value of the oldStorageKey record component.

Returns:

the value of the oldStorageKey record component

newSinkId

public String newSinkId()

Returns the value of the newSinkId record component.

Returns:

the value of the newSinkId record component

flavor

public PersistentFlavor<?> flavor()

Returns the value of the flavor record component.

Returns:

the value of the flavor record component