models_v2.common_pre_backup_script_params module

class models_v2.common_pre_backup_script_params.CommonPreBackupScriptParams(path=None, params=None, timeout_secs=None, is_active=None, continue_on_error=None)

Bases: object

Implementation of the ‘Common PreBackup Script Params’ model.

Specifies the common params for PreBackup scripts.

Attributes:

path (string): Specifies the absolute path to the script on the remote

host.

params (string): Specifies the arguments or parameters and values to

pass into the remote script. For example if the script expects values for the ‘database’ and ‘user’ parameters, specify the parameters and values using the following string: “database=myDatabase user=me”.

timeout_secs (int): Specifies the timeout of the script in seconds.

The script will be killed if it exceeds this value. By default, no timeout will occur if left empty.

is_active (bool): Specifies whether the script should be enabled,

default value set to true.

continue_on_error (bool): Specifies if the script needs to continue

even if there is an occurence of an error. If this flag is set to true, then Backup Run will start even if the pre backup script fails. If not specified or false, then backup run will not start when script fails.

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.