models.remote_vault_search_job_information module

class models.remote_vault_search_job_information.RemoteVaultSearchJobInformation(cluster_count=None, end_time_usecs=None, error=None, job_count=None, name=None, search_job_status=None, search_job_uid=None, start_time_usecs=None, vault_id=None, vault_name=None)[source]

Bases: object

Implementation of the ‘RemoteVaultSearchJobInformation’ model.

Specifies information about a search of a remote Vault.

Attributes:
cluster_count (int): Specifies number of Clusters that have archived

to the remote Vault and match the search criteria for this job, up to this point in the search. If the search is complete, the total number of Clusters that have archived to the remote Vault and that match the search criteria for this search Job, are reported. If the search is not complete, a partial number is reported.

end_time_usecs (long|int): Specifies the end time of the search as a

Unix epoch Timestamp (in microseconds) if the search Job has completed.

error (string): Specifies the error message reported when a search

fails.

job_count (int): Specifies number of Protection Jobs that have

archived to the remote Vault and match the search criteria for this search Job, up to this point in the search. If the search is complete, the total number of Protection Jobs that have archived to the remote Vault and that match the search criteria for this search Job, are reported. If the search is not complete, a partial number is reported.

name (string): Specifies the name of the search Job. search_job_status (SearchJobStatusEnum): Specifies the status of the

search. ‘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.

search_job_uid (UniversalId): Specifies the unique id assigned to the

search Job by the Cluster.

start_time_usecs (long|int): Specifies the start time of the search as

a Unix epoch Timestamp (in microseconds).

vault_id (long|int): Specifies the id of the remote Vault (External

Target) that was searched.

vault_name (string): Specifies the name of the remote Vault (External

Target) that was searched.

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.