models.restore_task_state_base_proto module

class models.restore_task_state_base_proto.RestoreTaskStateBaseProto(cancellation_requested=None, end_time_usecs=None, error=None, is_internal=None, name=None, parent_source_connection_params=None, public_status=None, refresh_status=None, restore_vlan_params=None, scheduled_constituent_id=None, scheduled_gandalf_session_id=None, start_time_usecs=None, status=None, task_id=None, total_logical_size_bytes=None, total_physical_size_bytes=None, mtype=None, user=None, user_info=None, user_messages=None, warnings=None)

Bases: object

Implementation of the ‘RestoreTaskStateBaseProto’ model.

TODO: type model description here.

Attributes:

cancellation_requested (bool): Whether this task has a pending

cancellation request.

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

field contains the end time for the task.

error (ErrorProto): TODO: type description here. is_internal (bool): Whether the restore task is internal. This is

currently used by standby restore tasks.

name (string): The name of the restore task. parent_source_connection_params (ConnectorParams): Message that

encapsulates the various params required to establish a connection with a particular environment.

public_status (int): Iris-facing task state. This field is stamped

during the export.

refresh_status (int): Status of the refresh task. restore_vlan_params (RestoreVlanParams): TODO: type description here. scheduled_constituent_id (long|int): Constituent id (and the gandalf

session id) where this task has been scheduled. If -1, the task is not running at any slave. It’s possible that the task was previously scheduled, but is now being re-scheduled.

scheduled_gandalf_session_id (long|int): TODO: type description here. start_time_usecs (long|int): The start time for this restore task. status (int): Status of the restore task. task_id (long|int): A globally unique id for this task. total_logical_size_bytes (long|int): Logical size of this restore

task. This is the amount of data that needs to be transferred to restore the entity.

total_physical_size_bytes (long|int): Physical size of this restore

task. This is the amount of data that was actually transferred to restore the entity.

mtype (int): The type of restore being performed. user (string): The user who requested this restore task. user_info (UserInformation): A message to encapsulate information

about the user who made the request. Request should be filtered by these fields if specified so that only the objects that the user is permissioned for are returned. If both sid_vec & tenant_id are specified then an intersection of respective results should be returned.

user_messages (list of string): Messages displayed to the user for

this task (if any). Only valid if the status of the task is kFinished. This is used for informing the user with additional details when there is not an error.

warnings (list of ErrorProto): The warnings encountered by this task

(if any) during its execution.

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.