Package com.inductiveautomation.ignition.gateway.storeforward

Interface SinkLifecycleEvent

All Known Implementing Classes:

SinkLifecycleEvent.SinkDeleted, SinkLifecycleEvent.SinkRenamed

public sealed interface SinkLifecycleEvent
permits SinkLifecycleEvent.SinkRenamed, SinkLifecycleEvent.SinkDeleted

Sealed interface representing lifecycle events for data sinks in the store-and-forward system.

These events allow flavor-scoped sink operations, ensuring that changes to a sink in one subsystem (e.g., tag history) do not inadvertently affect pipelines in other subsystems (e.g., alarm journal or audit).

Since:

8.3.4

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	SinkLifecycleEvent.SinkDeleted	Event indicating that a sink has been deleted.
static final record	SinkLifecycleEvent.SinkRenamed	Event indicating that a sink has been renamed.

Method Summary

Static Methods

Modifier and Type	Method	Description
static SinkLifecycleEvent.SinkDeleted	sinkDeleted(DataSink<?> sink)	Creates a SinkLifecycleEvent.SinkDeleted event by extracting the storage key, flavor, and engine-bound status from the sink.
static SinkLifecycleEvent.SinkRenamed	sinkRenamed(DataSink<?> sink, String newSinkId)	Creates a SinkLifecycleEvent.SinkRenamed event by extracting the storage key and flavor from the sink.

Method Details

sinkRenamed

static SinkLifecycleEvent.SinkRenamed sinkRenamed(DataSink<?> sink,
 String newSinkId)

Creates a SinkLifecycleEvent.SinkRenamed event by extracting the storage key and flavor from the sink.

Parameters:

sink - the sink being renamed

newSinkId - the new sink identifier

Returns:

a new SinkRenamed event

sinkDeleted

static SinkLifecycleEvent.SinkDeleted sinkDeleted(DataSink<?> sink)

Creates a SinkLifecycleEvent.SinkDeleted event by extracting the storage key, flavor, and engine-bound status from the sink.

Parameters:

sink - the sink being deleted

Returns:

a new SinkDeleted event

Since:

8.3.5