Kinetica   C#   API  Version 7.2.3.1
ShowBackup.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 Options
25  {
29  public const string BACKUP_ID = "backup_id";
30 
55  public const string BACKUP_TYPE = "backup_type";
56 
58  public const string ALL = "all";
59 
61  public const string FULL = "full";
62 
64  public const string INCREMENTAL = "incremental";
65 
67  public const string DIFFERENTIAL = "differential";
68 
91  public const string SHOW_CONTENTS = "show_contents";
92 
94  public const string NONE = "none";
95 
98  public const string OBJECT_NAMES = "object_names";
99 
102  public const string OBJECT_FILES = "object_files";
103 
117  public const string NO_ERROR_IF_NOT_EXISTS = "no_error_if_not_exists";
118 
119  public const string TRUE = "true";
120  public const string FALSE = "false";
121  } // end struct Options
122 
127  public string backup_name { get; set; } = "";
128 
130  public string datasource_name { get; set; }
131 
218  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
219 
222  public ShowBackupRequest() { }
223 
320  string datasource_name,
321  IDictionary<string, string> options = null)
322  {
323  this.backup_name = backup_name ?? "";
324  this.datasource_name = datasource_name ?? "";
325  this.options = options ?? new Dictionary<string, string>();
326  } // end constructor
327 } // end class ShowBackupRequest
328 
333 {
336  public string backup_name { get; set; }
337 
339  public IList<IDictionary<string, string>> backup_description { get; set; } = new List<IDictionary<string, string>>();
340 
343  public IList<IDictionary<string, string>> backup_ids { get; set; } = new List<IDictionary<string, string>>();
344 
353  public IList<IDictionary<string, string>> backup_contents { get; set; } = new List<IDictionary<string, string>>();
354 
357  public IList<IDictionary<string, string>> deleted_backup_ids { get; set; } = new List<IDictionary<string, string>>();
358 
360  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
361 } // end class ShowBackupResponse
A set of parameters for Kinetica.showBackup.
Definition: ShowBackup.cs:19
KineticaData - class to help with Avro Encoding for Kinetica
Definition: KineticaData.cs:14
const string INCREMENTAL
Show incremental backups only.
Definition: ShowBackup.cs:64
IList< IDictionary< string, string > > backup_description
Details about the overall backup(s).
Definition: ShowBackup.cs:339
A set of results returned by Kinetica.showBackup.
Definition: ShowBackup.cs:332
const string ALL
Show all backup types.
Definition: ShowBackup.cs:58
const string NO_ERROR_IF_NOT_EXISTS
Whether or not to suppress the error if the specified backup does not exist.
Definition: ShowBackup.cs:117
const string BACKUP_ID
ID of the snapshot to show.
Definition: ShowBackup.cs:29
const string FULL
Show full backups only.
Definition: ShowBackup.cs:61
A set of string constants for the parameter options.
Definition: ShowBackup.cs:24
IList< IDictionary< string, string > > backup_ids
Details about the individual snapshots contained within the backup(s).
Definition: ShowBackup.cs:343
string backup_name
Value of backup_name.
Definition: ShowBackup.cs:336
IDictionary< string, string > options
Optional parameters.
Definition: ShowBackup.cs:218
const string NONE
Don't show snapshot contents.
Definition: ShowBackup.cs:94
const string SHOW_CONTENTS
Show the contents of the backed-up snapshots.
Definition: ShowBackup.cs:91
const string OBJECT_FILES
Show backed-up object names, and for tables, sizing detail and associated files.
Definition: ShowBackup.cs:102
string backup_name
Name of the backup.
Definition: ShowBackup.cs:127
IList< IDictionary< string, string > > backup_contents
When SHOW_CONTENTS is OBJECT_NAMES, the names of the backed-up objects as well as sizing detail of an...
Definition: ShowBackup.cs:353
const string DIFFERENTIAL
Show differential backups only.
Definition: ShowBackup.cs:67
IDictionary< string, string > info
Additional information.
Definition: ShowBackup.cs:360
ShowBackupRequest(string backup_name, string datasource_name, IDictionary< string, string > options=null)
Constructs a ShowBackupRequest object with the specified parameters.
Definition: ShowBackup.cs:319
const string OBJECT_NAMES
Show backed-up object names, and for tables, sizing detail.
Definition: ShowBackup.cs:98
IList< IDictionary< string, string > > deleted_backup_ids
IDs of any snapshots that have been deleted from the containing backup(s).
Definition: ShowBackup.cs:357
ShowBackupRequest()
Constructs a ShowBackupRequest object with default parameters.
Definition: ShowBackup.cs:222
const string BACKUP_TYPE
Show backups by type.
Definition: ShowBackup.cs:55
string datasource_name
Data source through which the backup is accessible.
Definition: ShowBackup.cs:130