Kinetica   C#   API  Version 7.2.3.0
CreateBackup.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  public class CreateBackupRequest : KineticaData
21  {
25  public struct BackupType
26  {
29  public const string DIFFERENTIAL = "differential";
30 
33  public const string FULL = "full";
34 
37  public const string INCREMENTAL = "incremental";
38  } // end struct BackupType
39 
45  public struct BackupObjectsMap
46  {
50  public const string ALL = "all";
51 
54  public const string CONTEXT = "context";
55 
58  public const string CREDENTIAL = "credential";
59 
62  public const string DATASINK = "datasink";
63 
66  public const string DATASOURCE = "datasource";
67 
71  public const string FUNCTION_ENVIRONMENT = "function_environment";
72 
77  public const string MONITOR = "monitor";
78 
81  public const string RESOURCE_GROUP = "resource_group";
82 
86  public const string ROLE = "role";
87 
90  public const string STORED_PROCEDURE = "stored_procedure";
91 
96  public const string TABLE = "table";
97 
102  public const string USER = "user";
103 
106  public const string USER_DEFINED_FUNCTION = "user_defined_function";
107  } // end struct BackupObjectsMap
108 
112  public struct Options
113  {
127  public const string CHECKSUM = "checksum";
128 
129  public const string TRUE = "true";
130  public const string FALSE = "false";
131 
133  public const string COMMENT = "comment";
134 
152  public const string DDL_ONLY = "ddl_only";
153 
168  public const string DELETE_INTERMEDIATE_BACKUPS = "delete_intermediate_backups";
169 
183  public const string DRY_RUN = "dry_run";
184 
188  public const string MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep";
189 
204  public const string RECREATE = "recreate";
205  } // end struct Options
206 
212  public string backup_name { get; set; }
213 
235  public string backup_type { get; set; }
236 
335  public IDictionary<string, string> backup_objects_map { get; set; } = new Dictionary<string, string>();
336 
339  public string datasink_name { get; set; }
340 
445  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
446 
449  public CreateBackupRequest() { }
450 
685  string backup_type,
686  IDictionary<string, string> backup_objects_map,
687  string datasink_name,
688  IDictionary<string, string> options = null)
689  {
690  this.backup_name = backup_name ?? "";
691  this.backup_type = backup_type ?? "";
692  this.backup_objects_map = backup_objects_map ?? new Dictionary<string, string>();
693  this.datasink_name = datasink_name ?? "";
694  this.options = options ?? new Dictionary<string, string>();
695  } // end constructor
696  } // end class CreateBackupRequest
697 
701  public class CreateBackupResponse : KineticaData
702  {
705  public string backup_name { get; set; }
706 
708  public long backup_id { get; set; }
709 
712  public long copied_bytes { get; set; }
713 
715  public long copied_files { get; set; }
716 
719  public long copied_records { get; set; }
720 
723  public long total_number_of_records { get; set; }
724 
726  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
727  } // end class CreateBackupResponse
728 } // end namespace kinetica
const string STORED_PROCEDURE
SQL Procedure
Definition: CreateBackup.cs:56
const string FULL
Snapshot of the given database objects and data.
Definition: CreateBackup.cs:25
long copied_records
Total number of records in all files copied for this snapshot
long total_number_of_records
Total number of records that can be restored from this snapshot
const string RESOURCE_GROUP
Resource group(s).
Definition: CreateBackup.cs:81
string backup_name
Name for this backup object.
const string COMMENT
Comments to store with this backup
Definition: CreateBackup.cs:96
IDictionary< string, string > options
Optional parameters.
long copied_files
Total number of files copied for this snapshot
const string ROLE
Role, role members (roles or users, recursively) and associated permissions
Definition: CreateBackup.cs:67
A set of string constants for the parameter options.
Definition: CreateBackup.cs:93
IDictionary< string, string > info
Additional information.
CreateBackupRequest()
Constructs a CreateBackupRequest object with default parameters.
const string DIFFERENTIAL
Snapshot of changes in the database objects and data since the last full snapshot.
Definition: CreateBackup.cs:24
const string MONITOR
Table Monitor (Stream)
Definition: CreateBackup.cs:59
const string CHECKSUM
Calculate checksum for backup files.
const string INCREMENTAL
Snapshot of changes in the database objects and data since the last snapshot of any kind.
Definition: CreateBackup.cs:23
const string FUNCTION_ENVIRONMENT
Python UDF function environment(s).
Definition: CreateBackup.cs:71
long copied_bytes
Total size of all files copied for this snapshot
const string MAX_INCREMENTAL_BACKUPS_TO_KEEP
Maximum number of incremental backups to keep.
string backup_name
Value of backup_name.
IDictionary< string, string > backup_objects_map
Map of objects to be captured in the backup.
const string DRY_RUN
Dry run of backup.
string backup_type
Type of backup to create.
const string ALL
All object types in a schema (excludes permissions, system configuration, host secret key,...
Definition: CreateBackup.cs:38
CreateBackupRequest(string backup_name, string backup_type, IDictionary< string, string > backup_objects_map, string datasink_name, IDictionary< string, string > options=null)
Constructs a CreateBackupRequest object with the specified parameters.
string datasink_name
Datasink where backup will be stored.
const string RECREATE
Replace the existing backup object with a new full backup if it already exists.
const string DELETE_INTERMEDIATE_BACKUPS
When the backup type is differential, delete any intermediate incremental or differential backups.
const string DDL_ONLY
Only save the DDL, do not backup table data.
const string USER
User (internal and external) and associated permissions
Definition: CreateBackup.cs:63