models.retrieve_archive_info module

class models.retrieve_archive_info.RetrieveArchiveInfo(avg_logical_transfer_rate_bps=None, bytes_transferred=None, end_time_usecs=None, error=None, logical_bytes_transferred=None, logical_size_bytes=None, progress_monitor_task_path=None, retrieved_entity_vec=None, skip_cloning_view=None, start_time_usecs=None, stub_view_name=None, stub_view_relative_dir_name=None, target_view_name=None, user_action_required_msg=None)

Bases: object

Implementation of the ‘RetrieveArchiveInfo’ model.

Proto to describe information about the retrieval of an archive task as provided by Icebox.

Attributes:

avg_logical_transfer_rate_bps (long|int): Average logical bytes

transfer rate in bytes per second as seen by Icebox.

bytes_transferred (long|int): Number of physical bytes transferred for

this retrieval task so far.

end_time_usecs (long|int): Time when this retrieval task ended at

Icebox side. If not set, then the retrieval has not ended yet.

error (ErrorProto):If the retrieval task has completed, the following

indicates whether there was an error in its completion.

logical_bytes_transferred (long|int): Number of logical bytes

transferred so far.

logical_size_bytes (long|int): Total logical size of the retrieval

task.

progress_monitor_task_path (string): The root path of the progress

monitor for this task.

retrieved_entity_vec (list of RetrieveArchiveInfoRetrievedEntity):

Contains info about all retrieved entities.

skip_cloning_view (bool): If true, we will use the view directly

without cloning it and delete it when the restore is complete.

start_time_usecs (long|int): Time when this retrieval task was started

by Icebox. If not set, then retrieval has not been started yet.

stub_view_name (string): The stub view that Icebox created. Stub view

can be used for selectively restoring or accessing files from an archive location.

stub_view_relative_dir_name (string): Relative directory inside the

stub view that corresponds with the archive.

target_view_name (string): The name of the target view where Icebox

has retrieved and staged the requested entities.

user_action_required_msg (string): Message to display in the UI if any

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

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.