Kinetica   C#   API  Version 7.2.3.0
AdminShowClusterOperations.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 AdminShowClusterOperationsRequest : KineticaData
21  {
25  public int history_index { get; set; } = 0;
26 
30  public IDictionary<string, string> options { get; set; } = new Dictionary<string, string>();
31 
35 
45  IDictionary<string, string> options = null)
46  {
47  this.history_index = history_index ?? 0;
48  this.options = options ?? new Dictionary<string, string>();
49  } // end constructor
50  } // end class AdminShowClusterOperationsRequest
51 
55  public class AdminShowClusterOperationsResponse : KineticaData
56  {
61  public struct InProgress
62  {
63  public const string TRUE = "true";
64  public const string FALSE = "false";
65  } // end struct InProgress
66 
71  public struct OverallStatus
72  {
75  public const string OK = "OK";
76 
78  public const string ERROR = "ERROR";
79  } // end struct OverallStatus
80 
85  public struct UserStopped
86  {
87  public const string TRUE = "true";
88  public const string FALSE = "false";
89  } // end struct UserStopped
90 
95  public struct DryRun
96  {
97  public const string TRUE = "true";
98  public const string FALSE = "false";
99  } // end struct DryRun
100 
105  public struct AddRanks
106  {
107  public const string TRUE = "true";
108  public const string FALSE = "false";
109  } // end struct AddRanks
110 
115  public struct AddRanksStatus
116  {
117  public const string NOT_STARTED = "NOT_STARTED";
118  public const string IN_PROGRESS = "IN_PROGRESS";
119  public const string INTERRUPTED = "INTERRUPTED";
120  public const string COMPLETED_OK = "COMPLETED_OK";
121  public const string ERROR = "ERROR";
122  } // end struct AddRanksStatus
123 
128  public struct RemoveRanks
129  {
130  public const string TRUE = "true";
131  public const string FALSE = "false";
132  } // end struct RemoveRanks
133 
138  public struct RemoveRanksStatus
139  {
140  public const string NOT_STARTED = "NOT_STARTED";
141  public const string IN_PROGRESS = "IN_PROGRESS";
142  public const string INTERRUPTED = "INTERRUPTED";
143  public const string COMPLETED_OK = "COMPLETED_OK";
144  public const string ERROR = "ERROR";
145  } // end struct RemoveRanksStatus
146 
151  public struct Rebalance
152  {
153  public const string TRUE = "true";
154  public const string FALSE = "false";
155  } // end struct Rebalance
156 
161  public struct RebalanceUnshardedData
162  {
163  public const string TRUE = "true";
164  public const string FALSE = "false";
165  } // end struct RebalanceUnshardedData
166 
172  public struct RebalanceUnshardedDataStatus
173  {
174  public const string NOT_STARTED = "NOT_STARTED";
175  public const string IN_PROGRESS = "IN_PROGRESS";
176  public const string INTERRUPTED = "INTERRUPTED";
177  public const string COMPLETED_OK = "COMPLETED_OK";
178  public const string ERROR = "ERROR";
179  } // end struct RebalanceUnshardedDataStatus
180 
185  public struct RebalanceShardedData
186  {
187  public const string TRUE = "true";
188  public const string FALSE = "false";
189  } // end struct RebalanceShardedData
190 
196  public struct RebalanceShardedDataStatus
197  {
198  public const string NOT_STARTED = "NOT_STARTED";
199  public const string IN_PROGRESS = "IN_PROGRESS";
200  public const string INTERRUPTED = "INTERRUPTED";
201  public const string COMPLETED_OK = "COMPLETED_OK";
202  public const string ERROR = "ERROR";
203  } // end struct RebalanceShardedDataStatus
204 
208  public int history_index { get; set; }
209 
211  public int history_size { get; set; }
212 
224  public bool in_progress { get; set; }
225 
227  public string start_time { get; set; }
228 
231  public string end_time { get; set; }
232 
235  public string endpoint { get; set; }
236 
238  public string endpoint_schema { get; set; }
239 
254  public string overall_status { get; set; }
255 
267  public bool user_stopped { get; set; }
268 
270  public int percent_complete { get; set; }
271 
282  public bool dry_run { get; set; }
283 
285  public IList<string> messages { get; set; } = new List<string>();
286 
298  public bool add_ranks { get; set; }
299 
325  public string add_ranks_status { get; set; }
326 
330  public IList<int> ranks_being_added { get; set; } = new List<int>();
331 
334  public IList<string> rank_hosts { get; set; } = new List<string>();
335 
338  public int add_ranks_percent_complete { get; set; }
339 
351  public bool remove_ranks { get; set; }
352 
382  public string remove_ranks_status { get; set; }
383 
386  public IList<int> ranks_being_removed { get; set; } = new List<int>();
387 
390  public int remove_ranks_percent_complete { get; set; }
391 
403  public bool rebalance { get; set; }
404 
416  public bool rebalance_unsharded_data { get; set; }
417 
449  public string rebalance_unsharded_data_status { get; set; }
450 
453  public int unsharded_rebalance_percent_complete { get; set; }
454 
466  public bool rebalance_sharded_data { get; set; }
467 
472  public long shard_array_version { get; set; }
473 
503  public string rebalance_sharded_data_status { get; set; }
504 
507  public int num_shards_changing { get; set; }
508 
511  public int sharded_rebalance_percent_complete { get; set; }
512 
514  public IDictionary<string, string> info { get; set; } = new Dictionary<string, string>();
515  } // end class AdminShowClusterOperationsResponse
516 } // end namespace kinetica
int history_index
The index of this cluster operation in the reverse-chronologically sorted list of operations,...
IList< string > messages
Updates and error messages if any.
IList< int > ranks_being_added
The rank numbers of the ranks currently being added, or the rank numbers that were added if the opera...
int sharded_rebalance_percent_complete
Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.
IDictionary< string, string > options
Optional parameters.
bool rebalance_sharded_data
Whether rebalancing of sharded data is (or was) part of this operation.
string add_ranks_status
If this was a rank-adding operation, the add-specific status of the operation.
long shard_array_version
Version of the shard array that is (or was) being rebalanced to.
int num_shards_changing
Number of shards that will change as part of rebalance.
string endpoint_schema
The schema for the original request.
bool remove_ranks
Whether removing ranks is (or was) part of this operation.
bool add_ranks
Whether adding ranks is (or was) part of this operation.
bool rebalance_unsharded_data
Whether rebalancing of unsharded data is (or was) part of this operation.
int add_ranks_percent_complete
Current percent complete of the add ranks operation.
IDictionary< string, string > info
Additional information.
string endpoint
The endpoint that initiated the cluster operation.
int remove_ranks_percent_complete
Current percent complete of the remove ranks operation.
string rebalance_sharded_data_status
If this was an operation that included rebalancing sharded data, the rebalancing-specific status of t...
bool user_stopped
Whether a user stopped this operation at any point while in progress.
const string ERROR
An error occurred executing the operation.
bool in_progress
Whether this cluster operation is currently in progress or not.
int history_index
Indicates which cluster operation to retrieve.
string overall_status
Overall success status of the operation.
string end_time
The end time of the cluster operation, if completed.
int history_size
Number of cluster operations executed to date.
IList< int > ranks_being_removed
The ranks being removed, or that have been removed if the operation is completed.
bool rebalance
Whether data and/or shard rebalancing is (or was) part of this operation.
int percent_complete
Percent complete of this entire operation.
IList< string > rank_hosts
The host IP addresses of the ranks being added, in the same order as the ranks_being_added list.
int unsharded_rebalance_percent_complete
Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.
string remove_ranks_status
If this was a rank-removing operation, the removal-specific status of the operation.
string start_time
The start time of the cluster operation.
bool dry_run
Whether this operation was a dry run.
string rebalance_unsharded_data_status
If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of...
AdminShowClusterOperationsRequest()
Constructs an AdminShowClusterOperationsRequest object with default parameters.
AdminShowClusterOperationsRequest(int? history_index=null, IDictionary< string, string > options=null)
Constructs an AdminShowClusterOperationsRequest object with the specified parameters.
const string OK
The operation was successful, or, if still in progress, the operation is successful so far.