Kinetica   C#   API  Version 7.2.3.1
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 
21 {
25  public struct BackupType
26  {
29  public const string DIFFERENTIAL = "differential";
30 
32  public const string FULL = "full";
33 
36  public const string INCREMENTAL = "incremental";
37  } // end struct BackupType
38 
44  public struct BackupObjectsMap
45  {
49  public const string ALL = "all";
50 
53  public const string CATALOG = "catalog";
54 
57  public const string CONTEXT = "context";
58 
61  public const string CREDENTIAL = "credential";
62 
65  public const string DATASINK = "datasink";
66 
69  public const string DATASOURCE = "datasource";
70 
73  public const string FUNCTION_ENVIRONMENT = "function_environment";
74 
77  public const string GRAPH = "graph";
78 
83  public const string MONITOR = "monitor";
84 
87  public const string RESOURCE_GROUP = "resource_group";
88 
92  public const string ROLE = "role";
93 
96  public const string STORED_PROCEDURE = "stored_procedure";
97 
105  public const string TABLE = "table";
106 
111  public const string USER = "user";
112 
115  public const string USER_DEFINED_FUNCTION = "user_defined_function";
116  } // end struct BackupObjectsMap
117 
121  public struct Options
122  {
136  public const string CHECKSUM = "checksum";
137 
138  public const string TRUE = "true";
139  public const string FALSE = "false";
140 
142  public const string COMMENT = "comment";
143 
161  public const string DDL_ONLY = "ddl_only";
162 
177  public const string DELETE_INTERMEDIATE_BACKUPS = "delete_intermediate_backups";
178 
192  public const string DRY_RUN = "dry_run";
193 
196  public const string MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep";
197 
211  public const string RECREATE = "recreate";
212  } // end struct Options
213 
219  public string backup_name { get; set; }
220 
242  public string backup_type { get; set; }
243 
353  public IDictionary<string, string> backup_objects_map { get; set; } = new Dictionary<string, string>();
354 
356  public string datasink_name { get; set; }
357 
461  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
462 
465  public CreateBackupRequest() { }
466 
710  string backup_type,
711  IDictionary<string, string> backup_objects_map,
712  string datasink_name,
713  IDictionary<string, string> options = null)
714  {
715  this.backup_name = backup_name ?? "";
716  this.backup_type = backup_type ?? "";
717  this.backup_objects_map = backup_objects_map ?? new Dictionary<string, string>();
718  this.datasink_name = datasink_name ?? "";
719  this.options = options ?? new Dictionary<string, string>();
720  } // end constructor
721 } // end class CreateBackupRequest
722 
727 {
730  public string backup_name { get; set; }
731 
733  public long backup_id { get; set; }
734 
736  public long copied_bytes { get; set; }
737 
739  public long copied_files { get; set; }
740 
743  public long copied_records { get; set; }
744 
747  public long total_number_of_records { get; set; }
748 
750  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
751 } // end class CreateBackupResponse
long backup_id
ID of the snapshot created.
const string MONITOR
Table monitor(s) / SQL stream(s).
Definition: CreateBackup.cs:83
A set of string constants for the parameter backup_objects_map.
Definition: CreateBackup.cs:44
const string TABLE
Table(s) and SQL view(s).
const string DELETE_INTERMEDIATE_BACKUPS
Whether or not to delete any intermediate snapshots when the backup_type is set to DIFFERENTIAL.
const string RECREATE
Whether or not to replace an existing backup object with a new backup with a full snapshot,...
IDictionary< string, string > backup_objects_map
Map of objects to be captured in the backup; must be specified when creating a full snapshot and left...
const string CONTEXT
Context(s).
Definition: CreateBackup.cs:57
const string GRAPH
Graph(s) definition.
Definition: CreateBackup.cs:77
const string DATASINK
Data sink(s).
Definition: CreateBackup.cs:65
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
A set of string constants for the parameter backup_type.
Definition: CreateBackup.cs:25
const string CATALOG
Data Lake catalog that is external to the database.
Definition: CreateBackup.cs:53
IDictionary< string, string > info
Additional information.
string backup_name
Name for this backup.
A set of parameters for Kinetica.createBackup.
Definition: CreateBackup.cs:20
const string MAX_INCREMENTAL_BACKUPS_TO_KEEP
Maximum number of incremental snapshots to keep.
const string STORED_PROCEDURE
SQL procedure(s).
Definition: CreateBackup.cs:96
const string ALL
All object types and data contained in the given schema(s).
Definition: CreateBackup.cs:49
const string CHECKSUM
Whether or not to calculate checksums for backup files.
const string ROLE
Role(s), role members (roles or users, recursively), and associated permissions.
Definition: CreateBackup.cs:92
long copied_bytes
Total size of all files copied for this snapshot.
const string FULL
Snapshot of the given database objects and data.
Definition: CreateBackup.cs:32
long total_number_of_records
Total number of records that can be restored from this snapshot.
const string DRY_RUN
Whether or not to perform a dry run of a backup operation.
IDictionary< string, string > options
Optional parameters.
long copied_files
Total number of files copied for this snapshot.
A set of string constants for the parameter options.
const string USER
User(s) (internal and external) and associated permissions.
A set of results returned by Kinetica.createBackup.
const string DATASOURCE
Data source(s).
Definition: CreateBackup.cs:69
const string DIFFERENTIAL
Snapshot of changes in the database objects and data since the last full snapshot.
Definition: CreateBackup.cs:29
const string CREDENTIAL
Credential(s).
Definition: CreateBackup.cs:61
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.
long copied_records
Total number of records in all files copied for this snapshot.
const string INCREMENTAL
Snapshot of changes in the database objects and data since the last snapshot of any kind.
Definition: CreateBackup.cs:36
const string USER_DEFINED_FUNCTION
UDF(s).
string backup_name
Value of backup_name.
string backup_type
Type of snapshot to create.
const string DDL_ONLY
Whether or not, for tables, to only backup DDL and not table data.
const string RESOURCE_GROUP
Resource group(s).
Definition: CreateBackup.cs:87
CreateBackupRequest()
Constructs a CreateBackupRequest object with default parameters.
const string COMMENT
Comments to store with this backup.
string datasink_name
Data sink through which the backup will be stored.
const string FUNCTION_ENVIRONMENT
Python UDF function environment(s).
Definition: CreateBackup.cs:73