Package com.seeq.link.sdk.export
Class ExportStatus
java.lang.Object
com.seeq.link.sdk.export.ExportStatus
Represents the status of the export, which is serialized to properties for the item
in Seeq (for example, "Export - Status" and "Export - Message").
-
Field Summary
FieldsModifier and TypeFieldDescriptionThe timestamp of the latest sample exported to the datasource.static final double
static final String
The wall-clock time of the most recent export (successful or not).A helpful message, especially for a failure, for the user to understand the status of export activity.static final double
Either SUCCESS or FAILED based on whether the last attempt to export was successful.static final String
double
A measure of how "expensive" the export operation is from the standpoint of retrieving the data and performing the calculation in Seeq. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
calculateAndSetToll
(RequestTimings requestTimings, TimeInstant startTime, TimeInstant endTime) double
calculateExpectedDuration
(TimeInstant startTime, TimeInstant endTime) static ExportStatus
Reads the export status from an item's properties, if they exist.void
Writes the export status to an item's properties.
-
Field Details
-
Success
- See Also:
-
Failed
- See Also:
-
Status
Either SUCCESS or FAILED based on whether the last attempt to export was successful. -
Message
A helpful message, especially for a failure, for the user to understand the status of export activity. -
Cursor
The timestamp of the latest sample exported to the datasource. -
Last_Write_Time
The wall-clock time of the most recent export (successful or not). -
Toll
public double TollA measure of how "expensive" the export operation is from the standpoint of retrieving the data and performing the calculation in Seeq. The units of this toll are "seconds per day", meaning that it takes so many seconds to do the calculation per day of time range. -
S_PER_MS
public static final double S_PER_MS- See Also:
-
DAYS_PER_MS
public static final double DAYS_PER_MS- See Also:
-
-
Constructor Details
-
ExportStatus
public ExportStatus()
-
-
Method Details
-
read
Reads the export status from an item's properties, if they exist.- Parameters:
itemsApi
- The ItemsApi interface to use to communicate with Seeq ServeritemID
- The ID of the item from which to read
-
write
Writes the export status to an item's properties.- Parameters:
itemsApi
- The ItemsApi interface to use to communicate with Seeq ServeritemID
- The ID of the item from which to read
-
calculateAndSetToll
public void calculateAndSetToll(RequestTimings requestTimings, TimeInstant startTime, TimeInstant endTime) -
calculateExpectedDuration
-