The Open API specification for Synapse is now available for download!

Download Open API Spec

TableStatus

org.sagebionetworks.repo.model.table.TableStatus

Object used to track the status of a Table.

Field Type Description
state TableState The Table's state can be one of the following enumerations
tableId STRING The ID of the table.
version INTEGER For cases where a query is run against a particualr version of a table, this will be that version. This field is exclueded for all other cases.
startedOn STRING The date-time when the status of this table last changed to PROCESSING.
changedOn STRING The date-time when the status of this table last changed.
resetToken STRING Whenever the status of a table is rest to PROCESSING, a new reset-token will be issued. The table status can only be set to AVAILABLE by providing the current reset-token.
lastTableChangeEtag STRING Whenever the status of a table is set to AVAILABLE, this will be set to the etag of the last table change applied to the index.
progressMessage STRING The current message of the progress tracker.
progressCurrent INTEGER The progress current value indicates how much progress has been made. For example: If progressTotal = 100; and progressCurrent = 50; then the work is 50% complete.
progressTotal INTEGER The progress total indicates the total amount of work to complete. For example: If progressTotal = 100; and progressCurrent = 50; then the work is 50% complete.
errorMessage STRING When processing fails, this is a one line error message.
errorDetails STRING When processing fails, this is the full stack trace of the error.
totalTimeMS INTEGER The total run time (MS) of the last processing job.