models.protection_shell_info module

class models.protection_shell_info.ProtectionShellInfo(end_time_usecs=None, error=None, job_run_id=None, run_type=None, start_time_usecs=None, status=None)[source]

Bases: object

Implementation of the ‘ProtectionShellInfo’ model.

end_time_usecs (long|int): Specifies the end time of the Protection

Run. The end time is specified as a Unix epoch Timestamp (in microseconds).

error (string): Specifies if an error occurred (if any) while

running this task. This field is populated when the status is equal to ‘kFailure’.

job_run_id (long|int): Specifies the id of the Job Run that ran the

backup task and the copy tasks.

run_type (RunTypeEnum): Specifies the type of backup such as

‘kRegular’, ‘kFull’, ‘kLog’ or ‘kSystem’. ‘kRegular’ indicates a incremental (CBT) backup. Incremental backups utilizing CBT (if supported) are captured of the target protection objects. The first run of a kRegular schedule captures all the blocks. ‘kFull’ indicates a full (no CBT) backup. A complete backup (all blocks) of the target protection objects are always captured and Change Block Tracking (CBT) is not utilized. ‘kLog’ indicates a Database Log backup. Capture the database transaction logs to allow rolling back to a specific point in time. ‘kSystem’ indicates a system backup. System backups are used to do bare metal recovery of the system to a specific point in time.

start_time_usecs (long|int): Specifies the start time of the

Protection Run. The start time is specified as a Unix epoch Timestamp (in microseconds). This time is when the task is queued to an internal queue where tasks are waiting to run.

status (StatusCopyRunEnum): Specifies the status of Backup task such as

‘kRunning’, ‘kSuccess’, ‘kFailure’ etc. ‘kAccepted’ indicates the task is queued to run but not yet running. ‘kRunning’ indicates the task is running. ‘kCanceling’ indicates a request to cancel the task has occurred but the task is not yet canceled. ‘kCanceled’ indicates the task has been canceled. ‘kSuccess’ indicates the task was successful. ‘kFailure’ indicates the task failed. ‘kWarning’ indicates the task has finished with warning. ‘kOnHold’ indicates the task is kept onHold. ‘kMissed’ indicates the task is missed

classmethod from_dictionary(dictionary)[source]

Creates an instance of this model from a dictionary


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.


object: An instance of this structure class.