A set of parameters for Kinetica.alterBackup. More…
Inheritance diagram for kinetica.AlterBackupRequest:
[legend]
Collaboration diagram for kinetica.AlterBackupRequest:
[legend]
Classes | |
| struct | Action |
| A set of string constants for the parameter AlterBackupRequest.action. More… | |
| struct | Options |
| A set of string constants for the parameter AlterBackupRequest.options. More… | |
Public Member Functions | |
| AlterBackupRequest () | |
| Constructs an AlterBackupRequest object with default parameters. | |
| AlterBackupRequest (string backup_name, string action, string _value, string datasink_name, IDictionary< string, string > options=null) | |
| Constructs an AlterBackupRequest object with the specified parameters. | |
| AlterBackupRequest () | |
| Constructs an AlterBackupRequest object with default parameters. | |
| AlterBackupRequest (string backup_name, string action, string _value, string datasink_name, IDictionary< string, string > options=null) | |
| Constructs an AlterBackupRequest 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 altered. | |
| string | action [get, set] |
| Operation to be applied. | |
| string | _value [get, set] |
| Value of the modification, depending on AlterBackupRequest.action. | |
| 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.alterBackup.
Alters an existing database backup, accessible via the data sink specified by AlterBackupRequest.datasink_name.
Definition at line 19 of file AlterBackup.cs.
Constructor & Destructor Documentation
◆ AlterBackupRequest() [1/4]
| inline |
Constructs an AlterBackupRequest object with default parameters.
Definition at line 174 of file AlterBackup.cs.
◆ AlterBackupRequest() [2/4]
| inline |
Constructs an AlterBackupRequest object with the specified parameters.
Parameters
| backup_name | Name of the backup to be altered. |
| action | Operation to be applied. Supported values:
|
| _value | Value of the modification, depending on action . |
| datasink_name | Data sink through which the backup is accessible. |
| options | Optional parameters.
|
Definition at line 255 of file AlterBackup.cs.
◆ AlterBackupRequest() [3/4]
| inline |
Constructs an AlterBackupRequest object with default parameters.
Definition at line 174 of file AlterBackup.cs.
◆ AlterBackupRequest() [4/4]
| inline |
Constructs an AlterBackupRequest object with the specified parameters.
Parameters
| backup_name | Name of the backup to be altered. |
| action | Operation to be applied. Supported values:
|
| _value | Value of the modification, depending on action . |
| datasink_name | Data sink through which the backup is accessible. |
| options | Optional parameters.
|
Definition at line 255 of file AlterBackup.cs.
Property Documentation
◆ _value
| getset |
Value of the modification, depending on AlterBackupRequest.action.
Definition at line 134 of file AlterBackup.cs.
◆ action
| getset |
Operation to be applied.
Supported values:
- CHECKSUM: Calculate checksum for backed-up files.
- DDL_ONLY: Whether or not to only save DDL and not back up table data, when taking future snapshots; set AlterBackupRequest._value to ‘true’ or ‘false’ for DDL only or DDL and table data, respectively.
- MAX_INCREMENTAL_BACKUPS_TO_KEEP: Maximum number of incremental snapshots to keep, when taking future snapshots; set AlterBackupRequest._value to the number of snapshots to keep.
- MERGE: Merges all snapshots within a backup and creates a single full snapshot.
- PURGE: Deletes a snapshot from a backup; set AlterBackupRequest._value to the snapshot ID to purge.
Definition at line 130 of file AlterBackup.cs.
◆ backup_name
| getset |
Name of the backup to be altered.
Definition at line 86 of file AlterBackup.cs.
◆ datasink_name
| getset |
Data sink through which the backup is accessible.
Definition at line 137 of file AlterBackup.cs.
◆ options
| getset |
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/AlterBackup.cs
- Kinetica/Protocol/AlterBackup.cs