models.copy_run module

class models.copy_run.CopyRun(copy_snapshot_tasks=None, data_lock_constraints=None, error=None, expiry_time_usecs=None, hold_for_legal_purpose=None, legal_holdings=None, run_start_time_usecs=None, stats=None, status=None, target=None, task_uid=None, user_action_message=None)[source]

Bases: object

Implementation of the ‘CopyRun’ model.

Specifies details about the Copy Run for a backup run of a Job Run. A Copy task copies snapshots resulted from a backup run to a snapshot target which could be ‘kLocal’, ‘kArchival’, or ‘kRemote’.

copy_snapshot_tasks (list of CopySnapshotTaskStatus): Specifies the

status information of each task that copies the snapshot taken for a Protection Source.

data_lock_constraints (DataLockConstraints): Specifies the datalock

constraints for a copy run task.

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

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

expiry_time_usecs (long|int): Specifies expiry time of the copies of

the snapshots in this Protection Run.

hold_for_legal_purpose (bool): Specifies whether legal hold is enabled

on this run. It is true if the run is put on legal hold. Independent of this flag, some of the entities may be on legal hold.

legal_holdings (list of LegalHoldings): Specifies the list of

Protection Source Ids and the legal hold status.

run_start_time_usecs (long|int): Specifies start time of the copy


stats (CopyRunStats): Stats for one copy task or aggregated stats of a

Copy Run in a Protection Job Run.

status (StatusCopyRunEnum): Specifies the aggregated status of copy

tasks 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.

target (SnapshotTargetSettings): Specifies settings about a target

where a copied Snapshot is stored. A target can be a Remote Cluster or an Archival External Target such as AWS or Tape.

task_uid (UniversalId): Specifies a globally unique id of the copy


user_action_message (string): Specifies a message to the user if any

manual intervention is needed to make forward progress for the archival task. This message is mainly relevant for tape based archival tasks where a backup admin might be asked to load a new media when the tape library does not have any more media to use.

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.