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 
34  public const string CONTEXT = "context";
35 
38  public const string CREDENTIAL = "credential";
39 
42  public const string DATASINK = "datasink";
43 
46  public const string DATASOURCE = "datasource";
47 
51  public const string FUNCTION_ENVIRONMENT = "function_environment";
52 
55  public const string GRAPH = "graph";
56 
61  public const string MONITOR = "monitor";
62 
65  public const string RESOURCE_GROUP = "resource_group";
66 
70  public const string ROLE = "role";
71 
74  public const string STORED_PROCEDURE = "stored_procedure";
75 
80  public const string TABLE = "table";
81 
86  public const string USER = "user";
87 
90  public const string USER_DEFINED_FUNCTION = "user_defined_function";
91  } // end struct RestoreObjectsMap
92 
96  public struct Options
97  {
101  public const string BACKUP_ID = "backup_id";
102 
116  public const string CHECKSUM = "checksum";
117 
122  public const string TRUE = "true";
123 
125  public const string FALSE = "false";
126 
145  public const string CREATE_SCHEMA_IF_NOT_EXIST = "create_schema_if_not_exist";
146 
163  public const string DDL_ONLY = "ddl_only";
164 
178  public const string DRY_RUN = "dry_run";
179 
198  public const string REINGEST = "reingest";
199 
206  public const string RENAMED_OBJECTS_SCHEMA = "renamed_objects_schema";
207 
236  public const string RESTORE_POLICY = "restore_policy";
237 
240  public const string NONE = "none";
241 
244  public const string REPLACE = "replace";
245 
253  public const string RENAME = "rename";
254  } // end struct Options
255 
259  public string backup_name { get; set; } = "";
260 
366  public IDictionary<string, string> restore_objects_map { get; set; } = new Dictionary<string, string>();
367 
370  public string datasource_name { get; set; }
371 
522  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
523 
526  public RestoreBackupRequest() { }
527 
791  IDictionary<string, string> restore_objects_map,
792  string datasource_name,
793  IDictionary<string, string> options = null)
794  {
795  this.backup_name = backup_name ?? "";
796  this.restore_objects_map = restore_objects_map ?? new Dictionary<string, string>();
797  this.datasource_name = datasource_name ?? "";
798  this.options = options ?? new Dictionary<string, string>();
799  } // end constructor
800  } // end class RestoreBackupRequest
801 
805  public class RestoreBackupResponse : KineticaData
806  {
810  public string backup_name { get; set; }
811 
813  public long backup_id { get; set; }
814 
816  public long restored_bytes { get; set; }
817 
819  public long restored_files { get; set; }
820 
822  public long restored_records { get; set; }
823 
826  public IDictionary<string, string> restored_objects { get; set; } = new Dictionary<string, string>();
827 
830  public IDictionary<string, string> renamed_objects { get; set; } = new Dictionary<string, string>();
831 
834  public IDictionary<string, string> failed_objects { get; set; } = new Dictionary<string, string>();
835 
837  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
838  } // end class RestoreBackupResponse
839 } // 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 CHECKSUM
Verify checksum for backup files.
const string FUNCTION_ENVIRONMENT
Python UDF function environment(s).
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.
A set of string constants for the parameter options.
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
const string RESOURCE_GROUP
Resource group(s).
string datasource_name
Datasource where backup is located.
long backup_id
The backup ID that was restored
const string TRUE
Restore table data by re-ingesting it.
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.
const string FALSE
Restore the persisted data files directly.
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.