A set of parameters for Kinetica.showBackup. More…
Inheritance diagram for kinetica.ShowBackupRequest:
[legend]
Collaboration diagram for kinetica.ShowBackupRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter ShowBackupRequest.options. More… | |
Public Member Functions | |
| ShowBackupRequest () | |
| Constructs a ShowBackupRequest object with default parameters. | |
| ShowBackupRequest (string backup_name, string datasource_name, IDictionary< string, string > options=null) | |
| Constructs a ShowBackupRequest object with the specified parameters. | |
| ShowBackupRequest () | |
| Constructs a ShowBackupRequest object with default parameters. | |
| ShowBackupRequest (string backup_name, string datasource_name, IDictionary< string, string > options=null) | |
| Constructs a ShowBackupRequest 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. | |
| string | datasource_name [get, set] |
| Data source 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.showBackup.
Shows information about one or more backups accessible via the data source specified by ShowBackupRequest.datasource_name.
Definition at line 20 of file ShowBackup.cs.
Constructor & Destructor Documentation
◆ ShowBackupRequest() [1/4]
| inline |
Constructs a ShowBackupRequest object with default parameters.
Definition at line 260 of file ShowBackup.cs.
◆ ShowBackupRequest() [2/4]
| inline |
Constructs a ShowBackupRequest object with the specified parameters.
Parameters
| backup_name | Name of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ”. |
| datasource_name | Data source through which the backup is accessible. |
| options | Optional parameters.
|
Definition at line 376 of file ShowBackup.cs.
◆ ShowBackupRequest() [3/4]
| inline |
Constructs a ShowBackupRequest object with default parameters.
Definition at line 260 of file ShowBackup.cs.
◆ ShowBackupRequest() [4/4]
| inline |
Constructs a ShowBackupRequest object with the specified parameters.
Parameters
| backup_name | Name of the backup. An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ”. |
| datasource_name | Data source through which the backup is accessible. |
| options | Optional parameters.
|
Definition at line 376 of file ShowBackup.cs.
Property Documentation
◆ backup_name
| getset |
Name of the backup.
An empty string or '' will show all existing backups. Any text followed by a '' will show backups whose name starts with that text. The default value is ”.
Definition at line 146 of file ShowBackup.cs.
◆ datasource_name
| getset |
Data source through which the backup is accessible.
Definition at line 149 of file ShowBackup.cs.
◆ options
| getset |
Optional parameters.
- BACKUP_ID: ID of the snapshot to show. Leave empty to show information from the most recent snapshot in the backup. The default value is ”.
- BACKUP_TYPE: Show backups by type. This option is ignored if BACKUP_ID is non-empty. Supported values:
- ALL: Show all backup types.
- FULL: Show full backups only.
- INCREMENTAL: Show incremental backups only.
- DIFFERENTIAL: Show differential backups only.
- SHOW_CONTENTS: Show the contents of the backed-up snapshots. Supported values:
- NONE: Don’t show snapshot contents.
- OBJECT_NAMES: Show backed-up object names, and for tables, sizing detail.
- OBJECT_FILES: Show backed-up object names, and for tables, sizing detail and associated files.
- 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 256 of file ShowBackup.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/ShowBackup.cs
- Kinetica/Protocol/ShowBackup.cs