db2ACS_ObjectStatus Db2 Advanced Copy Services (ACS) API data structure

db2ACS_ObjectStatus contains information about the status or progress of a snapshot backup operation, or the status or usability of a snapshot backup object.


typedef struct db2ACS_ObjectStatus
{
   /* The total and completed bytes refer only to the ACS snapshot backup
    * itself, not to the progress of any offloaded tape backup.
    *
    * A bytesTotal of 0 indicates that the progress could not be determined.
    * ----------------------------------------------------------------------- */
   db2Uint64                  bytesCompleted;
   db2Uint64                  bytesTotal;
   db2ACS_ProgressState       progressState;
   db2ACS_UsabilityState      usabilityState;
} db2ACS_ObjectStatus;

bytesCompleted: Data type: db2Uint64.
The amount of the snapshot backup that has completed, in bytes.
bytesTotal: Data type: db2Uint64.
The size of the completed snapshot backup, in bytes.
progressState: Data type: db2ACS_ProgressState.
The state of the snapshot backup operation. Values:

DB2ACS_PSTATE_UNKNOWN
DB2ACS_PSTATE_IN_PROGRESS
DB2ACS_PSTATE_SUCCESSFUL
DB2ACS_PSTATE_FAILED
usabilityState: Data type: db2ACS_UsabilityState.
The state of the snapshot backup object, how the snapshot backup object can be used. Values:

DB2ACS_USTATE_UNKNOWN
DB2ACS_USTATE_LOCALLY_MOUNTABLE
DB2ACS_USTATE_REMOTELY_MOUNTABLE
DB2ACS_USTATE_REPETITIVELY_RESTORABLE
DB2ACS_USTATE_DESTRUCTIVELY_RESTORABLE
DB2ACS_USTATE_SWAP_RESTORABLE
DB2ACS_USTATE_PHYSICAL_PROTECTION
DB2ACS_USTATE_FULL_COPY
DB2ACS_USTATE_DELETED
DB2ACS_USTATE_FORCED_MOUNT
DB2ACS_USTATE_BACKGROUND_MONITOR_PENDING
DB2ACS_USTATE_TAPE_BACKUP_PENDING
DB2ACS_USTATE_TAPE_BACKUP_IN_PROGRESS
DB2ACS_USTATE_TAPE_BACKUP_COMPLETE