A set of parameters for Kinetica.verifyBackup. More...
Inheritance diagram for VerifyBackupRequest:
Collaboration diagram for VerifyBackupRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| VerifyBackupRequest () | |
| Constructs a VerifyBackupRequest object with default parameters. More... | |
| VerifyBackupRequest (string backup_name, string datasource_name, IDictionary< string, string > options=null) | |
| Constructs a VerifyBackupRequest object with the specified parameters. More... | |
| Public Member Functions inherited from KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | backup_name = "" [get, set] |
| Name of the backup. More... | |
| string | datasource_name [get, set] |
| Data source through which the backup is accessible. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
Additional Inherited Members | |
| Static Public Member Functions inherited from KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.verifyBackup.
Inspects the requested database backup(s) for conformity at the remote file store accessible via the data source specified by datasource_name. By default all snapshots are inspected unless the option BACKUP_ID is used to target a specific instance. Returns backup verification results.
Definition at line 23 of file VerifyBackup.cs.
Constructor & Destructor Documentation
◆ VerifyBackupRequest() [1/2]
|
inline |
Constructs a VerifyBackupRequest object with default parameters.
Definition at line 61 of file VerifyBackup.cs.
◆ VerifyBackupRequest() [2/2]
|
inline |
Constructs a VerifyBackupRequest object with the specified parameters.
- Parameters
-
backup_name Name of the backup. An empty string or '*' will check all existing backups. Any text followed by a '*' will inspect backups whose name starts with that text. The default value is ''. datasource_name Data source through which the backup is accessible. options Optional parameters. - BACKUP_ID: ID of the snapshot to verify. Set to '-1' to verify only the most recent snapshot in the backup. Leave empty to verify all snapshots. The default value is '-1'.
Definition at line 83 of file VerifyBackup.cs.
Property Documentation
◆ backup_name
|
getset |
Name of the backup.
An empty string or '*' will check all existing backups. Any text followed by a '*' will inspect backups whose name starts with that text. The default value is ''.
Definition at line 41 of file VerifyBackup.cs.
◆ datasource_name
|
getset |
Data source through which the backup is accessible.
Definition at line 44 of file VerifyBackup.cs.
◆ options
|
getset |
Optional parameters.
- BACKUP_ID: ID of the snapshot to verify. Set to '-1' to verify only the most recent snapshot in the backup. Leave empty to verify all snapshots. The default value is '-1'.
The default value is an empty Dictionary.
Definition at line 57 of file VerifyBackup.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/VerifyBackup.cs
