Kinetica   C#   API  Version 7.2.3.1
AlterBackup.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 {
24  public struct Action
25  {
27  public const string CHECKSUM = "checksum";
28 
33  public const string DDL_ONLY = "ddl_only";
34 
38  public const string MAX_INCREMENTAL_BACKUPS_TO_KEEP = "max_incremental_backups_to_keep";
39 
42  public const string MERGE = "merge";
43 
46  public const string PURGE = "purge";
47  } // end struct Action
48 
52  public struct Options
53  {
55  public const string COMMENT = "comment";
56 
70  public const string DRY_RUN = "dry_run";
71 
72  public const string TRUE = "true";
73  public const string FALSE = "false";
74  } // end struct Options
75 
77  public string backup_name { get; set; }
78 
113  public string action { get; set; }
114 
117  public string _value { get; set; }
118 
120  public string datasink_name { get; set; }
121 
146  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
147 
150  public AlterBackupRequest() { }
151 
219  string action,
220  string _value,
221  string datasink_name,
222  IDictionary<string, string> options = null)
223  {
224  this.backup_name = backup_name ?? "";
225  this.action = action ?? "";
226  this._value = _value ?? "";
227  this.datasink_name = datasink_name ?? "";
228  this.options = options ?? new Dictionary<string, string>();
229  } // end constructor
230 } // end class AlterBackupRequest
231 
236 {
239  public string backup_name { get; set; }
240 
243  public long backup_id { get; set; }
244 
246  public long total_bytes { get; set; }
247 
250  public long total_number_of_records { get; set; }
251 
253  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
254 } // end class AlterBackupResponse
const string MAX_INCREMENTAL_BACKUPS_TO_KEEP
Maximum number of incremental snapshots to keep, when taking future snapshots; set _value to the numb...
Definition: AlterBackup.cs:38
long total_number_of_records
Total number of records affected by the alter operation.
Definition: AlterBackup.cs:250
A set of string constants for the parameter options.
Definition: AlterBackup.cs:52
AlterBackupRequest(string backup_name, string action, string _value, string datasink_name, IDictionary< string, string > options=null)
Constructs an AlterBackupRequest object with the specified parameters.
Definition: AlterBackup.cs:218
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
string _value
Value of the modification, depending on action.
Definition: AlterBackup.cs:117
long backup_id
ID of the snapshot affected by the alter operation, if any.
Definition: AlterBackup.cs:243
A set of results returned by Kinetica.alterBackup.
Definition: AlterBackup.cs:235
string action
Operation to be applied.
Definition: AlterBackup.cs:113
const string DDL_ONLY
Whether or not to only save DDL and not back up table data, when taking future snapshots; set _value ...
Definition: AlterBackup.cs:33
string backup_name
Name of the backup to be altered.
Definition: AlterBackup.cs:77
const string MERGE
Merges all snapshots within a backup and creates a single full snapshot.
Definition: AlterBackup.cs:42
string datasink_name
Data sink through which the backup is accessible.
Definition: AlterBackup.cs:120
const string PURGE
Deletes a snapshot from a backup; set _value to the snapshot ID to purge.
Definition: AlterBackup.cs:46
AlterBackupRequest()
Constructs an AlterBackupRequest object with default parameters.
Definition: AlterBackup.cs:150
IDictionary< string, string > options
Optional parameters.
Definition: AlterBackup.cs:146
string backup_name
Value of backup_name.
Definition: AlterBackup.cs:239
A set of parameters for Kinetica.alterBackup.
Definition: AlterBackup.cs:19
const string DRY_RUN
Whether or not to perform a dry run of a backup alteration.
Definition: AlterBackup.cs:70
IDictionary< string, string > info
Additional information.
Definition: AlterBackup.cs:253
A set of string constants for the parameter action.
Definition: AlterBackup.cs:24
long total_bytes
Total size of files affected by the alter operation.
Definition: AlterBackup.cs:246
const string COMMENT
Comments to store with the backup.
Definition: AlterBackup.cs:55
const string CHECKSUM
Calculate checksum for backed-up files.
Definition: AlterBackup.cs:27