models.retrieve_archive_task_state_proto module

class models.retrieve_archive_task_state_proto.RetrieveArchiveTaskStateProto(archival_target=None, archive_task_uid=None, backup_run_start_time_usecs=None, cancellation_requested=None, download_files_info=None, end_time_usecs=None, entity_vec=None, error=None, full_view_name_deprecated=None, job_uid=None, name=None, progress_monitor_task_path=None, restore_archive_files_info=None, restore_task_id=None, retrieval_info=None, start_time_usecs=None, status=None, task_uid=None, user=None, vault_restore_params=None, view_box_id=None, view_name_deprecated=None)

Bases: object

Implementation of the ‘RetrieveArchiveTaskStateProto’ model.

Persistent state of a retrieve of an archive task. Only one of either entity_vec or download_files_info needs to be specified in this proto, where entity_vec is for retrieving the whole objects from the archive, and download_files_info is for only downloading the specified files from the archive.

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.

archive_task_uid (UniversalIdProto): The uid of the archive to be

retrieved.

backup_run_start_time_usecs (long|int): The start time of the backup

run whose corresponding archive is being retrieved. This field is just used for logging purposes.

cancellation_requested (bool): Whether this retrieval task has a

pending cancellation request.

download_files_info (RetrieveArchiveTaskStateProtoDownloadFilesInfo):

Information required for Icebox when downloading files from an archived entity. This proto is specifically just for the current temporary solution for downloading a single from an archive, where we let icebox download the file for us. In the future once the new Yoda APIs for downloading files from archive stub views are ready, we will just discard this proto and make field 20 reserved.

end_time_usecs (long|int): If the retrieval task has finished, this

field contains the end time for the task.

entity_vec (list of EntityProto): Information on the exact set of

objects to retrieve from archive. Even if the user wanted to retrieve all objects from the archive, this field will contain all individual leaf-level objects.

error (ErrorProto): The error encountered by task (if any). Only valid

if the task has finished.

full_view_name_deprecated (string): The full view name (external).

This is composed of a Cohesity specific prefix and the user provided view name.

job_uid (UniversalIdProto): The uid of the job to which the archive to

be retrieved belongs to.

name (string): The name of the retrieval task. progress_monitor_task_path (string): The path of the progress monitor

for this task.

restore_archive_files_info

(RetrieveArchiveTaskStateProtoDownloadFilesInfo): Information required for Icebox when downloading files from an archived entity. This proto is specifically just for the current temporary solution for downloading a single from an archive, where we let icebox download the file for us. In the future once the new Yoda APIs for downloading files from archive stub views are ready, we will just discard this proto and make field 20 reserved.

restore_task_id (long|int): For retrieve tasks created after the 2.8

release, this will contain the id of the restore task that created this retrieve task.

retrieval_info (RetrieveArchiveInfo): Proto to describe information

about the retrieval of an archive task as provided by Icebox.

start_time_usecs (long|int): The start time for this retrieval task. status (int): The status of this task. task_uid (UniversalIdProto): The globally unique id for this retrieval

of an archive task.

user (string): The user who requested this retrieval task. vault_restore_params (VaultParamsRestoreParams): Params to be passed

to Icebox while restoring data from an archive.

view_box_id (long|int): The view box id to which ‘view_name’ belongs

to.

view_name_deprecated (string): The view name as provided by the user

for this retrieval task. Retrieved snapshots of the entities will be placed in this view.

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.