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 {
16  public class CreateBackupRequest : KineticaData
17  {
21  public struct BackupType
22  {
23  public const string INCREMENTAL = "incremental";
24  public const string DIFFERENTIAL = "differential";
25  public const string FULL = "full";
26  } // end struct BackupType
27 
33  public struct BackupObjectsMap
34  {
38  public const string ALL = "all";
39 
41  public const string TABLE = "table";
42 
44  public const string CREDENTIAL = "credential";
45 
47  public const string CONTEXT = "context";
48 
50  public const string DATASINK = "datasink";
51 
53  public const string DATASOURCE = "datasource";
54 
56  public const string STORED_PROCEDURE = "stored_procedure";
57 
59  public const string MONITOR = "monitor";
60 
63  public const string USER = "user";
64 
67  public const string ROLE = "role";
68 
84  public const string CONFIGURATION = "configuration";
85 
86  public const string FALSE = "false";
87  public const string TRUE = "true";
88  } // end struct BackupObjectsMap
89 
93  public struct Options
94  {
96  public const string COMMENT = "comment";
97 
110  public const string CHECKSUM = "checksum";
111 
112  public const string FALSE = "false";
113  public const string TRUE = "true";
114 
127  public const string DDL_ONLY = "ddl_only";
128 
132  public const string MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep";
133 
147  public const string DELETE_INTERMEDIATE_BACKUPS = "delete_intermediate_backups";
148 
162  public const string RECREATE = "recreate";
163 
176  public const string DRY_RUN = "dry_run";
177  } // end struct Options
178 
183  public string backup_name { get; set; }
184 
200  public string backup_type { get; set; }
201 
278  public IDictionary<string, string> backup_objects_map { get; set; } = new Dictionary<string, string>();
279 
281  public string datasink_name { get; set; }
282 
380  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
381 
384  public CreateBackupRequest() { }
385 
585  string backup_type,
586  IDictionary<string, string> backup_objects_map,
587  string datasink_name,
588  IDictionary<string, string> options = null)
589  {
590  this.backup_name = backup_name ?? "";
591  this.backup_type = backup_type ?? "";
592  this.backup_objects_map = backup_objects_map ?? new Dictionary<string, string>();
593  this.datasink_name = datasink_name ?? "";
594  this.options = options ?? new Dictionary<string, string>();
595  } // end constructor
596  } // end class CreateBackupRequest
597 
601  public class CreateBackupResponse : KineticaData
602  {
605  public string backup_name { get; set; }
606 
608  public long backup_id { get; set; }
609 
611  public long copied_bytes { get; set; }
612 
614  public long copied_files { get; set; }
615 
618  public long copied_records { get; set; }
619 
622  public long total_number_of_records { get; set; }
623 
625  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
626  } // end class CreateBackupResponse
627 } // end namespace kinetica
const string STORED_PROCEDURE
SQL Procedure
Definition: CreateBackup.cs:56
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
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 CONFIGURATION
If TRUE, backup the database configuration file.
Definition: CreateBackup.cs:84
const string ROLE
Role, role members (roles or users, recursively) and associated permissions
Definition: CreateBackup.cs:67
IDictionary< string, string > info
Additional information.
CreateBackupRequest()
Constructs a CreateBackupRequest object with default parameters.
const string MONITOR
Table Monitor (Stream)
Definition: CreateBackup.cs:59
const string CHECKSUM
Calculate checksum for backup files.
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