Overview Package Class Deprecated Help

db
AuxiliaryDbBackup

Auxiliary database backup object provides details of database backups including schedules time and status.

public class AuxiliaryDbBackup

Properties
backupEndTimestamp

type=Date
access=read-only
default=0
Displayed(tab/group)=Backup End Time (Auxiliary Database Backups/Scheduled Backup)
backupFrequency

type=int
default=24
minimum=1
maximum=168
Displayed(tab/group)=Backup Repeating Interval(hours) (Auxiliary Database Backups/Scheduled Backup)
backupLocation

type=string
default=
minimum=0
maximum=200
Displayed(tab/group)=Backup Location (Auxiliary Database Backups/Scheduled Backup)
backupStartTimestamp

type=Date
access=read-only
default=0
Displayed(tab/group)=Backup Start Time (Auxiliary Database Backups/Scheduled Backup)
backupState

type=db.AuxiliaryDbBackupState
access=read-only
default=notAttempted
Displayed(tab/group)=Latest Backup State (Auxiliary Database Backups/Scheduled Backup)
backupSyncTime

type=Date
default=0
Displayed(tab/group)=Backup Sync Time (Auxiliary Database Backups/Scheduled Backup)
backupType

type=db.AuxiliaryDbBackupType
access=read-only
default=MANUAL
lastHandlerNode

type=string
access=read-only
default=
nextBackupStartTime

type=Date
access=read-only
default=0
Displayed(tab/group)=Next Backup Start Time (Auxiliary Database Backups/Scheduled Backup)
numberOfBackupToKeep

type=int
default=2
minimum=0
maximum=7
Displayed(tab/group)=Number of previous backups to keep (Auxiliary Database Backups/Scheduled Backup)
scheduledBackupEnabled

type=boolean
default=false
Displayed(tab/group)=Run Scheduled Backups (Auxiliary Database Backups/Scheduled Backup)
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

AuxDbBackup

Perform a database backup to the provided location on the database server. The ManualBackupDest and BackupType have to be set.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
instanceFullName : string - the full name of the object.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation - db.AuxiliaryDbBackup configuration information
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
db.AuxiliaryDbBackup.AuxDbBackupException