models.remote_restore_snapshot_status module¶
-
class
models.remote_restore_snapshot_status.
RemoteRestoreSnapshotStatus
(archive_task_uid=None, error=None, expiry_time_usecs=None, job_run_id=None, progress_monitor_task=None, snapshot_task_status=None, snapshot_task_uid=None, snapshot_time_usecs=None)[source]¶ Bases:
object
Implementation of the ‘RemoteRestoreSnapshotStatus’ model.
Specifies the status of a restore Snapshot task.
- Attributes:
- archive_task_uid (UniversalId): Specifies the globally unique id of
the archival task that archived the Snapshots to the remote Vault.
- error (string): Specifies the error message if the indexing task
fails.
- expiry_time_usecs (long|int): Specifies the time when the Snapshot
expires on the remote Vault. This field is recorded as a Unix epoch Timestamp (in microseconds).
- job_run_id (long|int): Specifies the id of the Job Run that originally
captured the Snapshot.
- progress_monitor_task (string): Specifies the path to the progress
monitor task that tracks the progress of building the index.
- snapshot_task_status (SnapshotTaskStatusEnum): Specifies the status of
the indexing task. ‘kJobRunning’ indicates that the Job/task is currently running. ‘kJobFinished’ indicates that the Job/task completed and finished. ‘kJobFailed’ indicates that the Job/task failed and did not complete. ‘kJobCanceled’ indicates that the Job/task was canceled. ‘kJobPaused’ indicates the Job/task is paused.
- snapshot_task_uid (UniversalId): Specifies the globally unique id of
the task capturing the Snapshot.
- snapshot_time_usecs (long|int): Specify the time the Snapshot was
captured. This time is recorded as a Unix epoch Timestamp (in microseconds).
-
classmethod
from_dictionary
(dictionary)[source]¶ Creates an instance of this model from a dictionary
- Args:
dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.
- Returns:
object: An instance of this structure class.