models.create_remote_vault_search_job_parameters module

class models.create_remote_vault_search_job_parameters.CreateRemoteVaultSearchJobParameters(search_job_name=None, vault_id=None, cluster_match_string=None, encryption_keys=None, end_time_usecs=None, job_match_string=None, start_time_usecs=None)

Bases: object

Implementation of the ‘CreateRemoteVaultSearchJobParameters’ model.

Specifies settings required to create a search of a remote Vault for data that has been archived from other Clusters.

Attributes:

cluster_match_string (string): Filter by specifying a Cluster name

prefix string. Only Clusters with names that start with this prefix string are returned in the search result. If not set, all Clusters archiving data to the Vault are returned in the search results.

encryption_keys (list of VaultEncryptionKey): Array of Encryption

Keys. Specifies an optional list of encryption keys that may be needed to search and restore data that was archived to a remote Vault. Archived data cannot be searched or restored without the corresponding encryption key used by the original Cluster to archive the data. Encryption keys can be uploaded using the REST API public/remoteVaults/encryptionKeys operation. If the key is already uploaded, this field does not need to be specified.

end_time_usecs (long|int): Filter by a end time specified as a Unix

epoch Timestamp (in microseconds). Only Job Runs that completed before the specified end time are included in the search results.

job_match_string (string): Filter by specifying a Protection Job name

prefix string. Only Protection Jobs with names that start with this prefix string are returned in the search result. If not set, all Protection Jobs archiving data to the Vault are returned in the search results.

search_job_name (string): Specifies the search Job name. start_time_usecs (long|int): Filter by a start time specified as a

Unix epoch Timestamp (in microseconds). Only Job Runs that started after the specified time are included in the search results.

vault_id (long|int): Specifies the id of the Vault to search. This id

was assigned by the local Cohesity Cluster when Vault was registered as an External Target.

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.