A set of parameters for Kinetica.dropBackup. More…
Inheritance diagram for kinetica.DropBackupRequest:
[legend]
Collaboration diagram for kinetica.DropBackupRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter DropBackupRequest.options. More… | |
Public Member Functions | |
| DropBackupRequest () | |
| Constructs a DropBackupRequest object with default parameters. | |
| DropBackupRequest (string backup_name, string datasink_name, IDictionary< string, string > options=null) | |
| Constructs a DropBackupRequest object with the specified parameters. | |
| DropBackupRequest () | |
| Constructs a DropBackupRequest object with default parameters. | |
| DropBackupRequest (string backup_name, string datasink_name, IDictionary< string, string > options=null) | |
| Constructs a DropBackupRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | backup_name [get, set] |
| Name of the backup to be deleted. | |
| string | datasink_name [get, set] |
| Data sink through which the backup is accessible. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.dropBackup.
Deletes one or more existing database backups and contained snapshots, accessible via the data sink specified by DropBackupRequest.datasink_name.
Definition at line 19 of file DropBackup.cs.
Constructor & Destructor Documentation
◆ DropBackupRequest() [1/4]
| inline |
Constructs a DropBackupRequest object with default parameters.
Definition at line 178 of file DropBackup.cs.
◆ DropBackupRequest() [2/4]
| inline |
Constructs a DropBackupRequest object with the specified parameters.
Parameters
| backup_name | 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_BACKUPS must be set to TRUE. |
| datasink_name | Data sink through which the backup is accessible. |
| options | Optional parameters.
|
Definition at line 263 of file DropBackup.cs.
◆ DropBackupRequest() [3/4]
| inline |
Constructs a DropBackupRequest object with default parameters.
Definition at line 178 of file DropBackup.cs.
◆ DropBackupRequest() [4/4]
| inline |
Constructs a DropBackupRequest object with the specified parameters.
Parameters
| backup_name | 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_BACKUPS must be set to TRUE. |
| datasink_name | Data sink through which the backup is accessible. |
| options | Optional parameters.
|
Definition at line 263 of file DropBackup.cs.
Property Documentation
◆ backup_name
| getset |
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_BACKUPS must be set to TRUE.
Definition at line 98 of file DropBackup.cs.
◆ datasink_name
| getset |
Data sink through which the backup is accessible.
Definition at line 101 of file DropBackup.cs.
◆ options
| getset |
Optional parameters.
- DRY_RUN: Whether or not to perform a dry run of a backup deletion. Supported values:The default value is FALSE.
- DELETE_ALL_BACKUPS: Allow multiple backups to be deleted if TRUE and multiple backup names are found matching DropBackupRequest.backup_name. Supported values:The default value is FALSE.
- NO_ERROR_IF_NOT_EXISTS: Whether or not to suppress the error if the specified backup does not exist. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 174 of file DropBackup.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/DropBackup.cs
- Kinetica/Protocol/DropBackup.cs