Package com.inductiveautomation.ignition.gateway.history

Interface DataSinkInformation

All Superinterfaces:
Serializable
All Known Implementing Classes:
DefaultDataSinkInfo
public interface DataSinkInformation extends Serializable

  • Method Summary

    Modifier and Type
    Method
    Description
    DataStoreStatus
    getDataStoreStatus()
     
    String
    getDescriptionKey()
    Returns a key that points to a useful name describing the store, such as "Memory Buffer" or "Local Cache".
    List<LocalizedString>
    getMessages()
    Returns any messages that the data sink might want to display.
    StatMetric
    getStorageMetric()
    Retrieves the metric for data flowing into the sink/store.
    boolean
    isAvailable()
     
    boolean
    isDataStore()
    Returns whether this sink is also a DataStore (aka data cache, the "store" part of store and forward).
    If it is, statistics can be retrieved through getDataStoreStatus

  • Method Details

    • getDescriptionKey

      String getDescriptionKey()
      Returns a key that points to a useful name describing the store, such as "Memory Buffer" or "Local Cache".

    • isAvailable

      boolean isAvailable()

    • isDataStore

      boolean isDataStore()
      Returns whether this sink is also a DataStore (aka data cache, the "store" part of store and forward).
      If it is, statistics can be retrieved through getDataStoreStatus

    • getDataStoreStatus

      @Nullable DataStoreStatus getDataStoreStatus()

    • getStorageMetric

      StatMetric getStorageMetric()
      Retrieves the metric for data flowing into the sink/store. If this is a store, will be the same as getDataStoreStatus().getStorageMetric()

    • getMessages

      List<LocalizedString> getMessages()
      Returns any messages that the data sink might want to display.