models.restore_object module

class models.restore_object.RestoreObject(archival_target=None, attempt_num=None, cloud_deploy_target=None, cloud_replication_target=None, entity=None, job_id=None, job_instance_id=None, job_uid=None, nosql_recover_params=None, parent_source=None, point_in_time_restore_time_usecs=None, recover_from_standby=None, restore_acropolis_vm_param=None, snapshot_relative_dir_path=None, start_time_usecs=None, view_name=None, vm_had_independent_disks=None)

Bases: object

Implementation of the ‘RestoreObject’ model.

TODO: type model description here.

Attributes:

archival_target (ArchivalTarget): Message that specifies the details

about an archival target (such as cloud or tape) where backup snapshots may be archived to.

attempt_num (int): The attempt number of the job run to restore from. cloud_deploy_target (CloudDeployTarget): Message that specifies the

details about CloudDeploy target where backup snapshots may be converted and stored.

cloud_replication_target (CloudDeployTarget): Message that specifies

the details about CloudDeploy target where backup snapshots may be converted and stored.

entity (EntityProto): Specifies the attributes and the latest

statistics about an entity.

job_id (long|int): The job id from which to restore. This is used

while communicating with yoda.

job_instance_id (long|int): Id identifying a specific run to restore

from. If this is not specified, and we need to restore from a run, the latest run is used. NOTE: This must be specified for RestoreFiles, RecoverDisks and GetVirtualDisks APIs.

job_uid (UniversalIdProto): TODO: type description here. nosql_recover_params (NoSqlRecoverParams): This field contains params

specific to the restore of a nosql entity.

parent_source (EntityProto): Specifies the attributes and the latest

statistics about an entity.

point_in_time_restore_time_usecs (int): The time to which the object

needs to be restored. If this is not set, then the object will be restored to the full/incremental snapshot. This is applicable only if the object is protected using CDP.

recover_from_standby (bool): This field indicates if the object should

be recovered from standby if it is enabled.

restore_acropolis_vm_param (RestoreAcropolisVMParam): TODO: type

description here.

snapshot_relative_dir_path (string): The relative path to the

directory containing the entity’s snapshot.

start_time_usecs (long|int): The start time of the specific job run.

Iff ‘job_instance_id’ is set, this field must be set. In-memory indices on the Magneto master are laid-out by the start time of the job, and this is how the master pulls up a specific run. NOTE: This must be specified for RestoreFiles, RecoverDisks and GetVirtualDisks APIs

view_name (string): The name of the view where the object’s snapshot

is located.

vm_had_independent_disks (bool): This is applicable only to VMs and is

set to true when the VM being recovered or cloned contained independent disks when it was backed up.

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.