Kinetica   C#   API  Version 7.2.3.1
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 
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 
50  public const string FUNCTION_ENVIRONMENT = "function_environment";
51 
54  public const string GRAPH = "graph";
55 
60  public const string MONITOR = "monitor";
61 
64  public const string RESOURCE_GROUP = "resource_group";
65 
69  public const string ROLE = "role";
70 
73  public const string STORED_PROCEDURE = "stored_procedure";
74 
84  public const string TABLE = "table";
85 
90  public const string USER = "user";
91 
94  public const string USER_DEFINED_FUNCTION = "user_defined_function";
95  } // end struct RestoreObjectsMap
96 
100  public struct Options
101  {
105  public const string BACKUP_ID = "backup_id";
106 
120  public const string CHECKSUM = "checksum";
121 
126  public const string TRUE = "true";
127 
129  public const string FALSE = "false";
130 
148  public const string CREATE_SCHEMA_IF_NOT_EXIST = "create_schema_if_not_exist";
149 
165  public const string DDL_ONLY = "ddl_only";
166 
180  public const string DRY_RUN = "dry_run";
181 
203  public const string RESTORE_SUBSCRIPTIONS = "restore_subscriptions";
204 
207  public const string RESUME = "resume";
208 
211  public const string PAUSE = "pause";
212 
214  public const string CANCEL = "cancel";
215 
233  public const string REINGEST = "reingest";
234 
240  public const string RENAMED_OBJECTS_SCHEMA = "renamed_objects_schema";
241 
269  public const string RESTORE_POLICY = "restore_policy";
270 
273  public const string NONE = "none";
274 
277  public const string REPLACE = "replace";
278 
285  public const string RENAME = "rename";
286  } // end struct Options
287 
291  public string backup_name { get; set; } = "";
292 
396  public IDictionary<string, string> restore_objects_map { get; set; } = new Dictionary<string, string>();
397 
400  public string datasource_name { get; set; }
401 
575  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
576 
579  public RestoreBackupRequest() { }
580 
865  IDictionary<string, string> restore_objects_map,
866  string datasource_name,
867  IDictionary<string, string> options = null)
868  {
869  this.backup_name = backup_name ?? "";
870  this.restore_objects_map = restore_objects_map ?? new Dictionary<string, string>();
871  this.datasource_name = datasource_name ?? "";
872  this.options = options ?? new Dictionary<string, string>();
873  } // end constructor
874 } // end class RestoreBackupRequest
875 
880 {
883  public string backup_name { get; set; }
884 
886  public long backup_id { get; set; }
887 
889  public long restored_bytes { get; set; }
890 
892  public long restored_files { get; set; }
893 
895  public long restored_records { get; set; }
896 
899  public IDictionary<string, string> restored_objects { get; set; } = new Dictionary<string, string>();
900 
903  public IDictionary<string, string> renamed_objects { get; set; } = new Dictionary<string, string>();
904 
907  public IDictionary<string, string> failed_objects { get; set; } = new Dictionary<string, string>();
908 
910  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
911 } // end class RestoreBackupResponse
IDictionary< string, string > restored_objects
Database objects that were successfully restored and their associated types.
const string STORED_PROCEDURE
SQL procedure(s).
long restored_bytes
Total size of data restored from backup.
IDictionary< string, string > restore_objects_map
Map of database objects to be restored from the backup.
const string ROLE
Role(s), role members (roles or users, recursively), and associated permissions.
const string RESOURCE_GROUP
Resource group(s).
const string FALSE
Restore the persisted data files directly.
RestoreBackupRequest()
Constructs a RestoreBackupRequest object with default parameters.
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string BACKUP_ID
ID of the snapshot to restore.
IDictionary< string, string > options
Optional parameters.
IDictionary< string, string > failed_objects
Database objects that failed to be restored and their associated types.
IDictionary< string, string > info
Additional information.
const string GRAPH
Graph(s) definition.
const string PAUSE
Pause subscriptions that were active when the backup was made.
const string RENAME
If an object to be restored already exists with the same name, move that existing one to the schema s...
const string REINGEST
Behavior to apply when restoring table data.
string datasource_name
Data source through which the backup will be restored.
const string NONE
If an object to be restored already exists with the same name, abort and return error.
const string RESTORE_SUBSCRIPTIONS
Behavior to apply when restoring datasource subscriptions on tables.
long restored_records
Total number of records restored from backup.
const string CHECKSUM
Whether or not to verify checksums for backup files when restoring.
string backup_name
Name of the backup to restore from, which must refer to an existing backup.
const string RESUME
Resume subscriptions that were active when the backup was made.
const string RESTORE_POLICY
Behavior to apply when any database object to restore already exists.
const string FUNCTION_ENVIRONMENT
Python UDF function environment(s).
const string RENAMED_OBJECTS_SCHEMA
If the RESTORE_POLICY is RENAME, use this schema for relocated existing objects instead of the defaul...
const string DRY_RUN
Whether or not to perform a dry run of the restoration operation.
long backup_id
ID of the snapshot that was restored.
A set of string constants for the parameter restore_objects_map.
A set of parameters for Kinetica.restoreBackup.
const string DATASOURCE
Data source(s).
const string CREDENTIAL
Credential(s).
A set of string constants for the parameter options.
IDictionary< string, string > renamed_objects
Original and new names of database objects that were successfully restored and their associated types...
const string CREATE_SCHEMA_IF_NOT_EXIST
Behavior to apply when the schema containing any database object to restore does not already exist.
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.
long restored_files
Total number of files restored from backup.
A set of results returned by Kinetica.restoreBackup.
string backup_name
Value of backup_name.
const string MONITOR
Table monitor(s) / SQL stream(s).
const string TABLE
Table(s) and SQL view(s).
const string DDL_ONLY
Behavior to apply when restoring tables.
const string TRUE
Restore table data by re-ingesting it.
const string ALL
All object types and data contained in the given schema(s).
const string USER_DEFINED_FUNCTION
UDF(s).
const string USER
User(s) (internal and external) and associated permissions.
const string CANCEL
Cancel active subscriptions.
const string REPLACE
If an object to be restored already exists with the same name, replace it with the backup version.
const string DATASINK
Data sink(s).