models.source_backup_status module

class models.source_backup_status.SourceBackupStatus(apps_backup_status=None, current_snapshot_info=None, error=None, is_full_backup=None, num_restarts=None, parent_source_id=None, progress_monitor_task_path=None, quiesced=None, sla_violated=None, source=None, stats=None, status=None, warnings=None)

Bases: object

Implementation of the ‘SourceBackupStatus’ model.

Specifies the source object to protect and the current backup status.

Attributes:

apps_backup_status (list of AppEntityBackupStatusInfo): Specifies the

backup status at app/DB level.

current_snapshot_info (SnapshotInfo): Specifies details about the

snapshot task created to backup or copy one source object like a VM.

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

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

is_full_backup (bool): Specifies whether this is a ‘kFull’ or

‘kRegular’ backup of the Run. This may be true even if the scheduled backup type is ‘kRegular’. This will happen when this run corresponds to the first backup run of the Job or if no previous snapshot information is found.

num_restarts (int): Specifies the number of times the the task was

restarted because of the changes on the backup source host.

parent_source_id (long|int): Specifies the id of the registered

Protection Source that is the parent of the Objects that are protected by this Job Run.

progress_monitor_task_path (string): Specifies the yoda progress

monitor task path which is used to get pulse information about the source that is being backed up.

quiesced (bool): Specifies if app-consistent snapshot was captured.

This field is set to true, if an app-consistent snapshot was taken by quiescing applications and the file system before taking a backup.

sla_violated (bool): Specifies if the SLA was violated for the Job

Run. This field is set to true, if time to complete the Job Run is longer than the SLA specified. This field is populated when the status is set to ‘kSuccess’ or ‘kFailure’.

source (ProtectionSource): Specifies a generic structure that

represents a node in the Protection Source tree. Node details will depend on the environment of the Protection Source.

stats (BackupSourceStats): Specifies statistics about a Backup task in

a Protection Job Run. Specifies statistics for one backup task. One backup task is used to backup on Protection Source. This structure is also used to aggregate stats of a Backup tasks in a Protection Job Run.

status (StatusSourceBackupStatusEnum): Specifies the status of the

source object being protected. ‘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.

warnings (list of string): Array of Warnings. Specifies the warnings

that occurred (if any) while running this task.

classmethod from_dictionary(dictionary)

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.