models_v2.recover_database_params module

class models_v2.recover_database_params.RecoverDatabaseParams(database_name=None, oracle_base_folder=None, oracle_home_folder=None, db_files_destination=None, db_config_file_path=None, enable_archive_log_mode=None, pfile_parameter_map=None, bct_file_path=None, num_tempfiles=None, redo_log_config=None, is_multi_stage_restore=None, oracle_update_restore_options=None, restore_time_usecs=None, db_channels=None, recovery_mode=None, shell_evironment_vars=None, granular_restore_info=None)[source]

Bases: object

Implementation of the ‘RecoverDatabaseParams’ model.

Specifies recovery parameters when recovering to a database

database_name (string): Specifies a new name for the restored

database. If this field is not specified, then the original database will be overwritten after recovery.

oracle_base_folder (string): Specifies the oracle base folder at

selected host.

oracle_home_folder (string): Specifies the oracle home folder at

selected host.

db_files_destination (string): Specifies the location to restore

database files.

db_config_file_path (string): Specifies the config file path on

selected host which configures the restored database.

enable_archive_log_mode (bool): Specifies archive log mode for oracle


pfile_parameter_map (list of KeyValuePair): Specifies a key value pair

for pfile parameters.

bct_file_path (string): Specifies BCT file path. num_tempfiles (int): Specifies no. of tempfiles to be used for the

recovered database.

redo_log_config (RedoLogConfig): Specifies redo log config. is_multi_stage_restore (bool): Specifies whether this task is a

multistage restore task. If set, we migrate the DB after clone completes.

oracle_update_restore_options (OracleUpdateRestoreOptions): Specifies

the parameters that are needed for updating oracle restore options.

restore_time_usecs (long|int): Specifies the time in the past to which

the Oracle db needs to be restored. This allows for granular recovery of Oracle databases. If this is not set, the Oracle db will be restored from the full/incremental snapshot.

db_channels (list of OracleProtectionGroupDatabaseNodeChannel):

Specifies the Oracle database node channels info. If not specified, the default values assigned by the server are applied to all the databases.

recovery_mode (bool): Specifies if database should be left in recovery


shell_evironment_vars (list of ShellKeyValuePair): Specifies key value

pairs of shell variables which defines the restore shell environment.

granular_restore_info (RecoverOracleGranularRestoreInformation):

Specifies information about list of objects (PDBs) to restore.

classmethod from_dictionary(dictionary)[source]

Creates an instance of this model from a dictionary


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.


object: An instance of this structure class.