GPUdb C++ API  Version 7.2.2.4
admin_show_cluster_operations.h
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 #ifndef __ADMIN_SHOW_CLUSTER_OPERATIONS_H__
7 #define __ADMIN_SHOW_CLUSTER_OPERATIONS_H__
8 
9 namespace gpudb
10 {
23  struct AdminShowClusterOperationsRequest
24  {
29  AdminShowClusterOperationsRequest() :
30  historyIndex(int32_t()),
31  options(std::map<std::string, std::string>())
32  {
33  }
34 
45  AdminShowClusterOperationsRequest(const int32_t historyIndex_, const std::map<std::string, std::string>& options_):
46  historyIndex( historyIndex_ ),
47  options( options_ )
48  {
49  }
50 
55  int32_t historyIndex;
56 
60  std::map<std::string, std::string> options;
61  };
62 } // end namespace gpudb
63 
64 namespace avro
65 {
66  template<> struct codec_traits<gpudb::AdminShowClusterOperationsRequest>
67  {
68  static void encode(Encoder& e, const gpudb::AdminShowClusterOperationsRequest& v)
69  {
70  ::avro::encode(e, v.historyIndex);
71  ::avro::encode(e, v.options);
72  }
73 
74  static void decode(Decoder& d, gpudb::AdminShowClusterOperationsRequest& v)
75  {
76  if (::avro::ResolvingDecoder *rd = dynamic_cast< ::avro::ResolvingDecoder*>(&d))
77  {
78  const std::vector<size_t> fo = rd->fieldOrder();
79 
80  for (std::vector<size_t>::const_iterator it = fo.begin(); it != fo.end(); ++it)
81  {
82  switch (*it)
83  {
84  case 0:
85  ::avro::decode(d, v.historyIndex);
86  break;
87 
88  case 1:
89  ::avro::decode(d, v.options);
90  break;
91 
92  default:
93  break;
94  }
95  }
96  }
97  else
98  {
99  ::avro::decode(d, v.historyIndex);
100  ::avro::decode(d, v.options);
101  }
102  }
103  };
104 } // end namespace avro
105 
106 namespace gpudb
107 {
113  struct AdminShowClusterOperationsResponse
114  {
119  AdminShowClusterOperationsResponse() :
120  historyIndex(int32_t()),
121  historySize(int32_t()),
122  inProgress(bool()),
123  startTime(std::string()),
124  endTime(std::string()),
125  endpoint(std::string()),
126  endpointSchema(std::string()),
127  overallStatus(std::string()),
128  userStopped(bool()),
129  percentComplete(int32_t()),
130  dryRun(bool()),
131  messages(std::vector<std::string>()),
132  addRanks(bool()),
133  addRanksStatus(std::string()),
134  ranksBeingAdded(std::vector<int32_t>()),
135  rankHosts(std::vector<std::string>()),
136  addRanksPercentComplete(int32_t()),
137  removeRanks(bool()),
138  removeRanksStatus(std::string()),
139  ranksBeingRemoved(std::vector<int32_t>()),
140  removeRanksPercentComplete(int32_t()),
141  rebalance(bool()),
142  rebalanceUnshardedData(bool()),
143  rebalanceUnshardedDataStatus(std::string()),
144  unshardedRebalancePercentComplete(int32_t()),
145  rebalanceShardedData(bool()),
146  shardArrayVersion(int64_t()),
147  rebalanceShardedDataStatus(std::string()),
148  numShardsChanging(int32_t()),
149  shardedRebalancePercentComplete(int32_t()),
150  info(std::map<std::string, std::string>())
151  {
152  }
153 
158  int32_t historyIndex;
159 
163  int32_t historySize;
164 
173  bool inProgress;
174 
178  std::string startTime;
179 
183  std::string endTime;
184 
188  std::string endpoint;
189 
193  std::string endpointSchema;
194 
208  std::string overallStatus;
209 
219  bool userStopped;
220 
224  int32_t percentComplete;
225 
234  bool dryRun;
235 
239  std::vector<std::string> messages;
240 
249  bool addRanks;
250 
268  std::string addRanksStatus;
269 
274  std::vector<int32_t> ranksBeingAdded;
275 
280  std::vector<std::string> rankHosts;
281 
285  int32_t addRanksPercentComplete;
286 
295  bool removeRanks;
296 
314  std::string removeRanksStatus;
315 
320  std::vector<int32_t> ranksBeingRemoved;
321 
325  int32_t removeRanksPercentComplete;
326 
336  bool rebalance;
337 
347  bool rebalanceUnshardedData;
348 
366  std::string rebalanceUnshardedDataStatus;
367 
372  int32_t unshardedRebalancePercentComplete;
373 
383  bool rebalanceShardedData;
384 
390  int64_t shardArrayVersion;
391 
409  std::string rebalanceShardedDataStatus;
410 
414  int32_t numShardsChanging;
415 
420  int32_t shardedRebalancePercentComplete;
421 
425  std::map<std::string, std::string> info;
426  };
427 } // end namespace gpudb
428 
429 namespace avro
430 {
431  template<> struct codec_traits<gpudb::AdminShowClusterOperationsResponse>
432  {
433  static void encode(Encoder& e, const gpudb::AdminShowClusterOperationsResponse& v)
434  {
435  ::avro::encode(e, v.historyIndex);
436  ::avro::encode(e, v.historySize);
437  ::avro::encode(e, v.inProgress);
438  ::avro::encode(e, v.startTime);
439  ::avro::encode(e, v.endTime);
440  ::avro::encode(e, v.endpoint);
441  ::avro::encode(e, v.endpointSchema);
442  ::avro::encode(e, v.overallStatus);
443  ::avro::encode(e, v.userStopped);
444  ::avro::encode(e, v.percentComplete);
445  ::avro::encode(e, v.dryRun);
446  ::avro::encode(e, v.messages);
447  ::avro::encode(e, v.addRanks);
448  ::avro::encode(e, v.addRanksStatus);
449  ::avro::encode(e, v.ranksBeingAdded);
450  ::avro::encode(e, v.rankHosts);
451  ::avro::encode(e, v.addRanksPercentComplete);
452  ::avro::encode(e, v.removeRanks);
453  ::avro::encode(e, v.removeRanksStatus);
454  ::avro::encode(e, v.ranksBeingRemoved);
455  ::avro::encode(e, v.removeRanksPercentComplete);
456  ::avro::encode(e, v.rebalance);
457  ::avro::encode(e, v.rebalanceUnshardedData);
458  ::avro::encode(e, v.rebalanceUnshardedDataStatus);
459  ::avro::encode(e, v.unshardedRebalancePercentComplete);
460  ::avro::encode(e, v.rebalanceShardedData);
461  ::avro::encode(e, v.shardArrayVersion);
462  ::avro::encode(e, v.rebalanceShardedDataStatus);
463  ::avro::encode(e, v.numShardsChanging);
464  ::avro::encode(e, v.shardedRebalancePercentComplete);
465  ::avro::encode(e, v.info);
466  }
467 
468  static void decode(Decoder& d, gpudb::AdminShowClusterOperationsResponse& v)
469  {
470  if (::avro::ResolvingDecoder *rd = dynamic_cast< ::avro::ResolvingDecoder*>(&d))
471  {
472  const std::vector<size_t> fo = rd->fieldOrder();
473 
474  for (std::vector<size_t>::const_iterator it = fo.begin(); it != fo.end(); ++it)
475  {
476  switch (*it)
477  {
478  case 0:
479  ::avro::decode(d, v.historyIndex);
480  break;
481 
482  case 1:
483  ::avro::decode(d, v.historySize);
484  break;
485 
486  case 2:
487  ::avro::decode(d, v.inProgress);
488  break;
489 
490  case 3:
491  ::avro::decode(d, v.startTime);
492  break;
493 
494  case 4:
495  ::avro::decode(d, v.endTime);
496  break;
497 
498  case 5:
499  ::avro::decode(d, v.endpoint);
500  break;
501 
502  case 6:
503  ::avro::decode(d, v.endpointSchema);
504  break;
505 
506  case 7:
507  ::avro::decode(d, v.overallStatus);
508  break;
509 
510  case 8:
511  ::avro::decode(d, v.userStopped);
512  break;
513 
514  case 9:
515  ::avro::decode(d, v.percentComplete);
516  break;
517 
518  case 10:
519  ::avro::decode(d, v.dryRun);
520  break;
521 
522  case 11:
523  ::avro::decode(d, v.messages);
524  break;
525 
526  case 12:
527  ::avro::decode(d, v.addRanks);
528  break;
529 
530  case 13:
531  ::avro::decode(d, v.addRanksStatus);
532  break;
533 
534  case 14:
535  ::avro::decode(d, v.ranksBeingAdded);
536  break;
537 
538  case 15:
539  ::avro::decode(d, v.rankHosts);
540  break;
541 
542  case 16:
543  ::avro::decode(d, v.addRanksPercentComplete);
544  break;
545 
546  case 17:
547  ::avro::decode(d, v.removeRanks);
548  break;
549 
550  case 18:
551  ::avro::decode(d, v.removeRanksStatus);
552  break;
553 
554  case 19:
555  ::avro::decode(d, v.ranksBeingRemoved);
556  break;
557 
558  case 20:
559  ::avro::decode(d, v.removeRanksPercentComplete);
560  break;
561 
562  case 21:
563  ::avro::decode(d, v.rebalance);
564  break;
565 
566  case 22:
567  ::avro::decode(d, v.rebalanceUnshardedData);
568  break;
569 
570  case 23:
571  ::avro::decode(d, v.rebalanceUnshardedDataStatus);
572  break;
573 
574  case 24:
575  ::avro::decode(d, v.unshardedRebalancePercentComplete);
576  break;
577 
578  case 25:
579  ::avro::decode(d, v.rebalanceShardedData);
580  break;
581 
582  case 26:
583  ::avro::decode(d, v.shardArrayVersion);
584  break;
585 
586  case 27:
587  ::avro::decode(d, v.rebalanceShardedDataStatus);
588  break;
589 
590  case 28:
591  ::avro::decode(d, v.numShardsChanging);
592  break;
593 
594  case 29:
595  ::avro::decode(d, v.shardedRebalancePercentComplete);
596  break;
597 
598  case 30:
599  ::avro::decode(d, v.info);
600  break;
601 
602  default:
603  break;
604  }
605  }
606  }
607  else
608  {
609  ::avro::decode(d, v.historyIndex);
610  ::avro::decode(d, v.historySize);
611  ::avro::decode(d, v.inProgress);
612  ::avro::decode(d, v.startTime);
613  ::avro::decode(d, v.endTime);
614  ::avro::decode(d, v.endpoint);
615  ::avro::decode(d, v.endpointSchema);
616  ::avro::decode(d, v.overallStatus);
617  ::avro::decode(d, v.userStopped);
618  ::avro::decode(d, v.percentComplete);
619  ::avro::decode(d, v.dryRun);
620  ::avro::decode(d, v.messages);
621  ::avro::decode(d, v.addRanks);
622  ::avro::decode(d, v.addRanksStatus);
623  ::avro::decode(d, v.ranksBeingAdded);
624  ::avro::decode(d, v.rankHosts);
625  ::avro::decode(d, v.addRanksPercentComplete);
626  ::avro::decode(d, v.removeRanks);
627  ::avro::decode(d, v.removeRanksStatus);
628  ::avro::decode(d, v.ranksBeingRemoved);
629  ::avro::decode(d, v.removeRanksPercentComplete);
630  ::avro::decode(d, v.rebalance);
631  ::avro::decode(d, v.rebalanceUnshardedData);
632  ::avro::decode(d, v.rebalanceUnshardedDataStatus);
633  ::avro::decode(d, v.unshardedRebalancePercentComplete);
634  ::avro::decode(d, v.rebalanceShardedData);
635  ::avro::decode(d, v.shardArrayVersion);
636  ::avro::decode(d, v.rebalanceShardedDataStatus);
637  ::avro::decode(d, v.numShardsChanging);
638  ::avro::decode(d, v.shardedRebalancePercentComplete);
639  ::avro::decode(d, v.info);
640  }
641  }
642  };
643 } // end namespace avro
644 
645 #endif // __ADMIN_SHOW_CLUSTER_OPERATIONS_H__
gpudb::AdminShowClusterOperationsResponse::inProgress
bool inProgress
Whether this cluster operation is currently in progress or not.
Definition: admin_show_cluster_operations.h:173
gpudb::AdminShowClusterOperationsResponse::addRanks
bool addRanks
Whether adding ranks is (or was) part of this operation.
Definition: admin_show_cluster_operations.h:249
gpudb::AdminShowClusterOperationsResponse::historyIndex
int32_t historyIndex
The index of this cluster operation in the reverse-chronologically sorted list of operations,...
Definition: admin_show_cluster_operations.h:158
gpudb::AdminShowClusterOperationsRequest
A set of parameters for GPUdb::adminShowClusterOperations.
Definition: admin_show_cluster_operations.h:23
gpudb::AdminShowClusterOperationsResponse::rebalanceUnshardedData
bool rebalanceUnshardedData
Whether rebalancing of unsharded data is (or was) part of this operation.
Definition: admin_show_cluster_operations.h:347
gpudb::AdminShowClusterOperationsResponse::addRanksStatus
std::string addRanksStatus
If this was a rank-adding operation, the add-specific status of the operation.
Definition: admin_show_cluster_operations.h:268
gpudb::AdminShowClusterOperationsResponse::removeRanksPercentComplete
int32_t removeRanksPercentComplete
Current percent complete of the remove ranks operation.
Definition: admin_show_cluster_operations.h:325
gpudb::AdminShowClusterOperationsResponse::overallStatus
std::string overallStatus
Overall success status of the operation.
Definition: admin_show_cluster_operations.h:208
gpudb::AdminShowClusterOperationsResponse::unshardedRebalancePercentComplete
int32_t unshardedRebalancePercentComplete
Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.
Definition: admin_show_cluster_operations.h:372
gpudb::AdminShowClusterOperationsResponse::endpoint
std::string endpoint
The endpoint that initiated the cluster operation.
Definition: admin_show_cluster_operations.h:188
gpudb::AdminShowClusterOperationsResponse::removeRanksStatus
std::string removeRanksStatus
If this was a rank-removing operation, the removal-specific status of the operation.
Definition: admin_show_cluster_operations.h:314
gpudb::AdminShowClusterOperationsResponse::removeRanks
bool removeRanks
Whether removing ranks is (or was) part of this operation.
Definition: admin_show_cluster_operations.h:295
gpudb::AdminShowClusterOperationsResponse::endpointSchema
std::string endpointSchema
The schema for the original request.
Definition: admin_show_cluster_operations.h:193
gpudb::AdminShowClusterOperationsResponse::ranksBeingAdded
std::vector< int32_t > ranksBeingAdded
The rank numbers of the ranks currently being added, or the rank numbers that were added if the opera...
Definition: admin_show_cluster_operations.h:274
gpudb::AdminShowClusterOperationsResponse::rebalanceUnshardedDataStatus
std::string rebalanceUnshardedDataStatus
If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of...
Definition: admin_show_cluster_operations.h:366
gpudb::AdminShowClusterOperationsRequest::AdminShowClusterOperationsRequest
AdminShowClusterOperationsRequest(const int32_t historyIndex_, const std::map< std::string, std::string > &options_)
Constructs an AdminShowClusterOperationsRequest object with the specified parameters.
Definition: admin_show_cluster_operations.h:45
gpudb::AdminShowClusterOperationsResponse::historySize
int32_t historySize
Number of cluster operations executed to date.
Definition: admin_show_cluster_operations.h:163
gpudb::AdminShowClusterOperationsResponse::messages
std::vector< std::string > messages
Updates and error messages if any.
Definition: admin_show_cluster_operations.h:239
gpudb::AdminShowClusterOperationsResponse::rankHosts
std::vector< std::string > rankHosts
The host IP addresses of the ranks being added, in the same order as the ranksBeingAdded list.
Definition: admin_show_cluster_operations.h:280
gpudb::AdminShowClusterOperationsResponse::dryRun
bool dryRun
Whether this operation was a dry run.
Definition: admin_show_cluster_operations.h:234
gpudb::AdminShowClusterOperationsResponse::shardedRebalancePercentComplete
int32_t shardedRebalancePercentComplete
Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.
Definition: admin_show_cluster_operations.h:420
gpudb::AdminShowClusterOperationsResponse::userStopped
bool userStopped
Whether a user stopped this operation at any point while in progress.
Definition: admin_show_cluster_operations.h:219
gpudb::AdminShowClusterOperationsResponse::AdminShowClusterOperationsResponse
AdminShowClusterOperationsResponse()
Constructs an AdminShowClusterOperationsResponse object with default parameters.
Definition: admin_show_cluster_operations.h:119
gpudb::AdminShowClusterOperationsResponse::numShardsChanging
int32_t numShardsChanging
Number of shards that will change as part of rebalance.
Definition: admin_show_cluster_operations.h:414
gpudb::AdminShowClusterOperationsResponse::rebalanceShardedDataStatus
std::string rebalanceShardedDataStatus
If this was an operation that included rebalancing sharded data, the rebalancing-specific status of t...
Definition: admin_show_cluster_operations.h:409
gpudb::AdminShowClusterOperationsResponse::ranksBeingRemoved
std::vector< int32_t > ranksBeingRemoved
The ranks being removed, or that have been removed if the operation is completed.
Definition: admin_show_cluster_operations.h:320
gpudb::AdminShowClusterOperationsRequest::AdminShowClusterOperationsRequest
AdminShowClusterOperationsRequest()
Constructs an AdminShowClusterOperationsRequest object with default parameters.
Definition: admin_show_cluster_operations.h:29
gpudb::AdminShowClusterOperationsResponse::addRanksPercentComplete
int32_t addRanksPercentComplete
Current percent complete of the add ranks operation.
Definition: admin_show_cluster_operations.h:285
gpudb::AdminShowClusterOperationsRequest::historyIndex
int32_t historyIndex
Indicates which cluster operation to retrieve.
Definition: admin_show_cluster_operations.h:55
gpudb::AdminShowClusterOperationsResponse::rebalanceShardedData
bool rebalanceShardedData
Whether rebalancing of sharded data is (or was) part of this operation.
Definition: admin_show_cluster_operations.h:383
gpudb::AdminShowClusterOperationsResponse::rebalance
bool rebalance
Whether data and/or shard rebalancing is (or was) part of this operation.
Definition: admin_show_cluster_operations.h:336
gpudb::AdminShowClusterOperationsResponse::shardArrayVersion
int64_t shardArrayVersion
Version of the shard array that is (or was) being rebalanced to.
Definition: admin_show_cluster_operations.h:390
gpudb::AdminShowClusterOperationsResponse::percentComplete
int32_t percentComplete
Percent complete of this entire operation.
Definition: admin_show_cluster_operations.h:224
gpudb::AdminShowClusterOperationsResponse::info
std::map< std::string, std::string > info
Additional information.
Definition: admin_show_cluster_operations.h:425
gpudb::AdminShowClusterOperationsRequest::options
std::map< std::string, std::string > options
Optional parameters.
Definition: admin_show_cluster_operations.h:60
gpudb::AdminShowClusterOperationsResponse::endTime
std::string endTime
The end time of the cluster operation, if completed.
Definition: admin_show_cluster_operations.h:183
gpudb::AdminShowClusterOperationsResponse::startTime
std::string startTime
The start time of the cluster operation.
Definition: admin_show_cluster_operations.h:178
gpudb::AdminShowClusterOperationsResponse
A set of results returned by GPUdb::adminShowClusterOperations.
Definition: admin_show_cluster_operations.h:113