Package com.gpudb.protocol
Class DropBackupRequest
java.lang.Object
com.gpudb.protocol.DropBackupRequest
All Implemented Interfaces:
org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecordA set of parameters for
GPUdb.dropBackup.
Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by datasinkName.
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic final classA set of string constants for theDropBackupRequestparameteroptions.Method Summary
Modifier and TypeMethodDescriptionbooleanget(int index) This method supports the Avro framework and is not intended to be called directly by the user.Name of the backup to be deleted.static org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.Data sink through which the backup is accessible.Optional parameters.org.apache.avro.SchemaThis method supports the Avro framework and is not intended to be called directly by the user.inthashCode()voidThis method supports the Avro framework and is not intended to be called directly by the user.setBackupName(String backupName) Name of the backup to be deleted.setDatasinkName(String datasinkName) Data sink through which the backup is accessible.setOptions(Map<String, String> options) Optional parameters.toString()
Constructor Details
DropBackupRequest
Constructs a DropBackupRequest object with the specified parameters.Parameters:backupName- Name of the backup to be deleted. An empty string or ’*’ will delete all existing backups. Any text followed by a ’*’ will delete backups whose name starts with that text. When deleting multiple backups,DELETE_ALL_BACKUPSmust be set toTRUE.datasinkName- Data sink through which the backup is accessible.options- Optional parameters.DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values:The default value isFALSE.DELETE_ALL_BACKUPS: Allow multiple backups to be deleted ifTRUEand multiple backup names are found matchingbackupName. Supported values:The default value isFALSE.NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:The default value isFALSE.
Map.
Method Details
getBackupName
Name of the backup to be deleted. An empty string or ’*’ will delete all existing backups. Any text followed by a ’*’ will delete backups whose name starts with that text. When deleting multiple backups,DELETE_ALL_BACKUPSmust be set toTRUE.Returns:The current value ofbackupName.setBackupName
Name of the backup to be deleted. An empty string or ’*’ will delete all existing backups. Any text followed by a ’*’ will delete backups whose name starts with that text. When deleting multiple backups,DELETE_ALL_BACKUPSmust be set toTRUE.Parameters:backupName- The new value forbackupName.Returns:thisto mimic the builder pattern.getOptions
Optional parameters.DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values:The default value isFALSE.DELETE_ALL_BACKUPS: Allow multiple backups to be deleted ifTRUEand multiple backup names are found matchingbackupName. Supported values:The default value isFALSE.NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:The default value isFALSE.
Map.Returns:The current value ofoptions.setOptions
Optional parameters.DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values:The default value isFALSE.DELETE_ALL_BACKUPS: Allow multiple backups to be deleted ifTRUEand multiple backup names are found matchingbackupName. Supported values:The default value isFALSE.NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:The default value isFALSE.
Map.Parameters:options- The new value foroptions.Returns:thisto mimic the builder pattern.