Kinetica   C#   API  Version 7.2.3.0
RestoreBackup.cs
Go to the documentation of this file.
1 /*
2  * This file was autogenerated by the Kinetica schema processor.
3  *
4  * DO NOT EDIT DIRECTLY.
5  */
6 
7 using System.Collections.Generic;
8 
9 namespace kinetica
10 {
19  public class RestoreBackupRequest : KineticaData
20  {
25  public struct RestoreObjectsMap
26  {
30  public const string ALL = "all";
31 
36  public const string TABLE = "table";
37 
40  public const string CREDENTIAL = "credential";
41 
44  public const string CONTEXT = "context";
45 
48  public const string DATASINK = "datasink";
49 
52  public const string DATASOURCE = "datasource";
53 
56  public const string STORED_PROCEDURE = "stored_procedure";
57 
62  public const string MONITOR = "monitor";
63 
68  public const string USER = "user";
69 
73  public const string ROLE = "role";
74 
91  public const string CONFIGURATION = "configuration";
92 
93  public const string TRUE = "true";
94  public const string FALSE = "false";
95  } // end struct RestoreObjectsMap
96 
100  public struct Options
101  {
105  public const string BACKUP_ID = "backup_id";
106 
134  public const string RESTORE_POLICY = "restore_policy";
135 
138  public const string NONE = "none";
139 
142  public const string REPLACE = "replace";
143 
149  public const string RENAME = "rename";
150 
157  public const string RENAMED_OBJECTS_SCHEMA = "renamed_objects_schema";
158 
177  public const string CREATE_SCHEMA_IF_NOT_EXIST = "create_schema_if_not_exist";
178 
179  public const string TRUE = "true";
180  public const string FALSE = "false";
181 
200  public const string REINGEST = "reingest";
201 
218  public const string DDL_ONLY = "ddl_only";
219 
233  public const string CHECKSUM = "checksum";
234 
248  public const string DRY_RUN = "dry_run";
249  } // end struct Options
250 
254  public string backup_name { get; set; } = "";
255 
352  public IDictionary<string, string> restore_objects_map { get; set; } = new Dictionary<string, string>();
353 
356  public string datasource_name { get; set; }
357 
507  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
508 
511  public RestoreBackupRequest() { }
512 
766  IDictionary<string, string> restore_objects_map,
767  string datasource_name,
768  IDictionary<string, string> options = null)
769  {
770  this.backup_name = backup_name ?? "";
771  this.restore_objects_map = restore_objects_map ?? new Dictionary<string, string>();
772  this.datasource_name = datasource_name ?? "";
773  this.options = options ?? new Dictionary<string, string>();
774  } // end constructor
775  } // end class RestoreBackupRequest
776 
780  public class RestoreBackupResponse : KineticaData
781  {
785  public string backup_name { get; set; }
786 
788  public long backup_id { get; set; }
789 
791  public long restored_bytes { get; set; }
792 
794  public long restored_files { get; set; }
795 
797  public long restored_records { get; set; }
798 
801  public IDictionary<string, string> restored_objects { get; set; } = new Dictionary<string, string>();
802 
805  public IDictionary<string, string> renamed_objects { get; set; } = new Dictionary<string, string>();
806 
809  public IDictionary<string, string> failed_objects { get; set; } = new Dictionary<string, string>();
810 
812  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
813  } // end class RestoreBackupResponse
814 } // end namespace kinetica
long restored_records
Total number of records restored from backup
const string REPLACE
If an object to be restored currently exists with the same name, replace it with the backup version
long restored_files
Total number of files restored from backup
const string CONFIGURATION
If TRUE, restore the database configuration file.
const string CHECKSUM
Verify checksum for backup files.
const string RESTORE_POLICY
Behavior to apply when restoring objects that already exist.
const string DRY_RUN
Does a dry-run restoration operation.
const string NONE
If an object to be restored currently exists with the same name, abort and return error
IDictionary< string, string > info
Additional information.
RestoreBackupRequest()
Constructs a RestoreBackupRequest object with default parameters.
IDictionary< string, string > renamed_objects
Original and new names of objects that were successfully restored and their associated types.
const string RENAME
If an object to be restored currently exists with the same name, rename the original version
string datasource_name
Datasource where backup is located.
long backup_id
The backup ID that was restored
const string REINGEST
Behavior to apply when restoring table data.
const string MONITOR
Table Monitor (Stream)
IDictionary< string, string > failed_objects
Objects that failed to be restored and their associated types.
const string RENAMED_OBJECTS_SCHEMA
If the restore policy is rename, optionally use this schema for renamed objects instead of a default ...
const string ROLE
Role, role members (roles or users, recursively) and associated permissions
IDictionary< string, string > restored_objects
Objects that were successfully restored and their associated types.
long restored_bytes
Total size of data restored from backup
const string USER
User (internal and external) and associated permissions
const string DDL_ONLY
Only recreates the objects from their DDL, do not restore table data.
const string ALL
All object types in a schema (excludes permissions, system configuration, host secret key,...
RestoreBackupRequest(string backup_name, IDictionary< string, string > restore_objects_map, string datasource_name, IDictionary< string, string > options=null)
Constructs a RestoreBackupRequest object with the specified parameters.
string backup_name
The backup name
IDictionary< string, string > options
Optional parameters.
const string BACKUP_ID
Backup instance ID to restore.
string backup_name
Name of the backup object, which must refer to a currently existing backup.
const string CREATE_SCHEMA_IF_NOT_EXIST
Create the schema for an object to be restored if it does not currently exist.
IDictionary< string, string > restore_objects_map
Map of objects to be restored from the backup.