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 {
16  public class RestoreBackupRequest : KineticaData
17  {
22  public struct RestoreObjectsMap
23  {
27  public const string ALL = "all";
28 
30  public const string TABLE = "table";
31 
33  public const string CREDENTIAL = "credential";
34 
36  public const string CONTEXT = "context";
37 
39  public const string DATASINK = "datasink";
40 
42  public const string DATASOURCE = "datasource";
43 
45  public const string STORED_PROCEDURE = "stored_procedure";
46 
48  public const string MONITOR = "monitor";
49 
52  public const string USER = "user";
53 
56  public const string ROLE = "role";
57 
73  public const string CONFIGURATION = "configuration";
74 
75  public const string FALSE = "false";
76  public const string TRUE = "true";
77  } // end struct RestoreObjectsMap
78 
82  public struct Options
83  {
87  public const string BACKUP_ID = "backup_id";
88 
114  public const string RESTORE_POLICY = "restore_policy";
115 
118  public const string NONE = "none";
119 
122  public const string REPLACE = "replace";
123 
126  public const string RENAME = "rename";
127 
132  public const string RENAMED_OBJECTS_SCHEMA = "renamed_objects_schema";
133 
147  public const string CREATE_SCHEMA_IF_NOT_EXIST = "create_schema_if_not_exist";
148 
149  public const string FALSE = "false";
150  public const string TRUE = "true";
151 
164  public const string REINGEST = "reingest";
165 
179  public const string DDL_ONLY = "ddl_only";
180 
193  public const string CHECKSUM = "checksum";
194 
207  public const string DRY_RUN = "dry_run";
208  } // end struct Options
209 
213  public string backup_name { get; set; } = "";
214 
293  public IDictionary<string, string> restore_objects_map { get; set; } = new Dictionary<string, string>();
294 
296  public string datasource_name { get; set; }
297 
429  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
430 
433  public RestoreBackupRequest() { }
434 
654  IDictionary<string, string> restore_objects_map,
655  string datasource_name,
656  IDictionary<string, string> options = null)
657  {
658  this.backup_name = backup_name ?? "";
659  this.restore_objects_map = restore_objects_map ?? new Dictionary<string, string>();
660  this.datasource_name = datasource_name ?? "";
661  this.options = options ?? new Dictionary<string, string>();
662  } // end constructor
663  } // end class RestoreBackupRequest
664 
668  public class RestoreBackupResponse : KineticaData
669  {
671  public string backup_name { get; set; }
672 
674  public long backup_id { get; set; }
675 
677  public long restored_bytes { get; set; }
678 
680  public long restored_files { get; set; }
681 
683  public long restored_records { get; set; }
684 
687  public IDictionary<string, string> restored_objects { get; set; } = new Dictionary<string, string>();
688 
691  public IDictionary<string, string> renamed_objects { get; set; } = new Dictionary<string, string>();
692 
695  public IDictionary<string, string> failed_objects { get; set; } = new Dictionary<string, string>();
696 
698  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
699  } // end class RestoreBackupResponse
700 } // 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
Restore table data by re-ingesting.
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.