models.remote_restore_indexing_status module¶
-
class
models.remote_restore_indexing_status.
RemoteRestoreIndexingStatus
(end_time_usecs=None, error=None, indexing_task_end_time_usecs=None, indexing_task_start_time_usecs=None, indexing_task_status=None, indexing_task_uid=None, latest_expiry_time_usecs=None, progress_monitor_task=None, start_time_usecs=None)[source]¶ Bases:
object
Implementation of the ‘RemoteRestoreIndexingStatus’ model.
Specifies the status of an indexing task.
- Attributes:
- end_time_usecs (long|int): Specifies the end time of the time range
that is being indexed. The indexing task is creating an index of the Job Runs that occurred between the startTimeUsecs and this endTimeUsecs. This field is recorded as a Unix epoch Timestamp (in microseconds).
- error (string): Specifies the error message if the indexing Job/task
fails.
- indexing_task_end_time_usecs (long|int): Specifies when the indexing
task completed. This time is recorded as a Unix epoch Timestamp (in microseconds). This field is not set if the indexing task is still in progress.
- indexing_task_start_time_usecs (long|int): Specifies when the indexing
task started. This time is recorded as a Unix epoch Timestamp (in microseconds).
- indexing_task_status (IndexingTaskStatusEnum): Specifies the status of
the indexing Job/task. ‘kJobRunning’ indicates that the Job/task is currently running. ‘kJobFinished’ indicates that the Job/task completed and finished. ‘kJobFailed’ indicates that the Job/task failed and did not complete. ‘kJobCanceled’ indicates that the Job/task was canceled. ‘kJobPaused’ indicates the Job/task is paused.
- indexing_task_uid (UniversalId): Specifies the unique id of the
indexing task assigned by this Cluster.
- latest_expiry_time_usecs (long|int): For all the Snapshots retrieved
by this Job, specifies the latest time when a Snapshot expires.
- progress_monitor_task (string): Specifies the path to progress monitor
task to track the progress of building the index.
- start_time_usecs (long|int): Specifies the start time of the time
range that is being indexed. The indexing task is creating an index of the Job Runs that occurred between this startTimeUsecs and the endTimeUsecs. This field is recorded as a Unix epoch Timestamp (in microseconds).
-
classmethod
from_dictionary
(dictionary)[source]¶ 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.