Package com.inductiveautomation.ignition.gateway.storeforward.sinks.info

Interface DataSinkInformation

All Known Subinterfaces:
DataStoreInformation
All Known Implementing Classes:
DefaultDataSinkInfo, DefaultDataStoreInfo
public interface DataSinkInformation
The DataSinkInformation interface provides information about a data sink.

  • Method Details

    • description

      LocalizedString description()
      Returns a localized description for the data sink.
      Returns:
      the name of the data sink

    • status

      SinkStatus status()
      Returns the status of the data sink.
      Returns:
      the status of the data sink

    • storeMetric

      com.codahale.metrics.Meter storeMetric()
      Returns the store metric for the data sink.
      Returns:
      the store metric for the data sink

    • messages

      List<LocalizedString> messages()
      Returns a list of messages associated with the data sink.
      Returns:
      a list of messages associated with the data sink

    • supportedFlavor

      PersistentFlavor<?> supportedFlavor()
      Returns the supported flavor for the data sink.
      Returns:
      the supported flavor for the data sink

    • storageKey

      StorageKey storageKey()
      Returns the storage key used for registration and data routing.
      Returns:
      the storage key for the data sink.