GPUdb C++ API  Version 7.2.2.4
gpudb::AdminShowClusterOperationsResponse Struct Reference

A set of results returned by GPUdb::adminShowClusterOperations. More...

#include <gpudb/protocol/admin_show_cluster_operations.h>

Public Member Functions

 AdminShowClusterOperationsResponse ()
 Constructs an AdminShowClusterOperationsResponse object with default parameters. More...
 

Public Attributes

int32_t historyIndex
 The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation. More...
 
int32_t historySize
 Number of cluster operations executed to date. More...
 
bool inProgress
 Whether this cluster operation is currently in progress or not. More...
 
std::string startTime
 The start time of the cluster operation. More...
 
std::string endTime
 The end time of the cluster operation, if completed. More...
 
std::string endpoint
 The endpoint that initiated the cluster operation. More...
 
std::string endpointSchema
 The schema for the original request. More...
 
std::string overallStatus
 Overall success status of the operation. More...
 
bool userStopped
 Whether a user stopped this operation at any point while in progress. More...
 
int32_t percentComplete
 Percent complete of this entire operation. More...
 
bool dryRun
 Whether this operation was a dry run. More...
 
std::vector< std::string > messages
 Updates and error messages if any. More...
 
bool addRanks
 Whether adding ranks is (or was) part of this operation. More...
 
std::string addRanksStatus
 If this was a rank-adding operation, the add-specific status of the operation. More...
 
std::vector< int32_t > ranksBeingAdded
 The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete. More...
 
std::vector< std::string > rankHosts
 The host IP addresses of the ranks being added, in the same order as the ranksBeingAdded list. More...
 
int32_t addRanksPercentComplete
 Current percent complete of the add ranks operation. More...
 
bool removeRanks
 Whether removing ranks is (or was) part of this operation. More...
 
std::string removeRanksStatus
 If this was a rank-removing operation, the removal-specific status of the operation. More...
 
std::vector< int32_t > ranksBeingRemoved
 The ranks being removed, or that have been removed if the operation is completed. More...
 
int32_t removeRanksPercentComplete
 Current percent complete of the remove ranks operation. More...
 
bool rebalance
 Whether data and/or shard rebalancing is (or was) part of this operation. More...
 
bool rebalanceUnshardedData
 Whether rebalancing of unsharded data is (or was) part of this operation. More...
 
std::string rebalanceUnshardedDataStatus
 If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation. More...
 
int32_t unshardedRebalancePercentComplete
 Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance. More...
 
bool rebalanceShardedData
 Whether rebalancing of sharded data is (or was) part of this operation. More...
 
int64_t shardArrayVersion
 Version of the shard array that is (or was) being rebalanced to. More...
 
std::string rebalanceShardedDataStatus
 If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation. More...
 
int32_t numShardsChanging
 Number of shards that will change as part of rebalance. More...
 
int32_t shardedRebalancePercentComplete
 Percentage of shard keys, and their associated data if applicable, that have completed rebalancing. More...
 
std::map< std::string, std::string > info
 Additional information. More...
 

Detailed Description

A set of results returned by GPUdb::adminShowClusterOperations.

Definition at line 113 of file admin_show_cluster_operations.h.

Constructor & Destructor Documentation

◆ AdminShowClusterOperationsResponse()

gpudb::AdminShowClusterOperationsResponse::AdminShowClusterOperationsResponse ( )
inline

Constructs an AdminShowClusterOperationsResponse object with default parameters.

Definition at line 119 of file admin_show_cluster_operations.h.

Member Data Documentation

◆ addRanks

bool gpudb::AdminShowClusterOperationsResponse::addRanks

Whether adding ranks is (or was) part of this operation.

Supported values:

  • true
  • false

Definition at line 249 of file admin_show_cluster_operations.h.

◆ addRanksPercentComplete

int32_t gpudb::AdminShowClusterOperationsResponse::addRanksPercentComplete

Current percent complete of the add ranks operation.

Definition at line 285 of file admin_show_cluster_operations.h.

◆ addRanksStatus

std::string gpudb::AdminShowClusterOperationsResponse::addRanksStatus

◆ dryRun

bool gpudb::AdminShowClusterOperationsResponse::dryRun

Whether this operation was a dry run.

Supported values:

  • true
  • false

Definition at line 234 of file admin_show_cluster_operations.h.

◆ endpoint

std::string gpudb::AdminShowClusterOperationsResponse::endpoint

The endpoint that initiated the cluster operation.

Definition at line 188 of file admin_show_cluster_operations.h.

◆ endpointSchema

std::string gpudb::AdminShowClusterOperationsResponse::endpointSchema

The schema for the original request.

Definition at line 193 of file admin_show_cluster_operations.h.

◆ endTime

std::string gpudb::AdminShowClusterOperationsResponse::endTime

The end time of the cluster operation, if completed.

Definition at line 183 of file admin_show_cluster_operations.h.

◆ historyIndex

int32_t gpudb::AdminShowClusterOperationsResponse::historyIndex

The index of this cluster operation in the reverse-chronologically sorted list of operations, where 0 is the most recent operation.

Definition at line 158 of file admin_show_cluster_operations.h.

◆ historySize

int32_t gpudb::AdminShowClusterOperationsResponse::historySize

Number of cluster operations executed to date.

Definition at line 163 of file admin_show_cluster_operations.h.

◆ info

std::map<std::string, std::string> gpudb::AdminShowClusterOperationsResponse::info

Additional information.

Definition at line 425 of file admin_show_cluster_operations.h.

◆ inProgress

bool gpudb::AdminShowClusterOperationsResponse::inProgress

Whether this cluster operation is currently in progress or not.

Supported values:

  • true
  • false

Definition at line 173 of file admin_show_cluster_operations.h.

◆ messages

std::vector<std::string> gpudb::AdminShowClusterOperationsResponse::messages

Updates and error messages if any.

Definition at line 239 of file admin_show_cluster_operations.h.

◆ numShardsChanging

int32_t gpudb::AdminShowClusterOperationsResponse::numShardsChanging

Number of shards that will change as part of rebalance.

Definition at line 414 of file admin_show_cluster_operations.h.

◆ overallStatus

std::string gpudb::AdminShowClusterOperationsResponse::overallStatus

Overall success status of the operation.

Supported values:

Definition at line 208 of file admin_show_cluster_operations.h.

◆ percentComplete

int32_t gpudb::AdminShowClusterOperationsResponse::percentComplete

Percent complete of this entire operation.

Definition at line 224 of file admin_show_cluster_operations.h.

◆ rankHosts

std::vector<std::string> gpudb::AdminShowClusterOperationsResponse::rankHosts

The host IP addresses of the ranks being added, in the same order as the ranksBeingAdded list.

Definition at line 280 of file admin_show_cluster_operations.h.

◆ ranksBeingAdded

std::vector<int32_t> gpudb::AdminShowClusterOperationsResponse::ranksBeingAdded

The rank numbers of the ranks currently being added, or the rank numbers that were added if the operation is complete.

Definition at line 274 of file admin_show_cluster_operations.h.

◆ ranksBeingRemoved

std::vector<int32_t> gpudb::AdminShowClusterOperationsResponse::ranksBeingRemoved

The ranks being removed, or that have been removed if the operation is completed.

Definition at line 320 of file admin_show_cluster_operations.h.

◆ rebalance

bool gpudb::AdminShowClusterOperationsResponse::rebalance

Whether data and/or shard rebalancing is (or was) part of this operation.

Supported values:

  • true
  • false

Definition at line 336 of file admin_show_cluster_operations.h.

◆ rebalanceShardedData

bool gpudb::AdminShowClusterOperationsResponse::rebalanceShardedData

Whether rebalancing of sharded data is (or was) part of this operation.

Supported values:

  • true
  • false

Definition at line 383 of file admin_show_cluster_operations.h.

◆ rebalanceShardedDataStatus

std::string gpudb::AdminShowClusterOperationsResponse::rebalanceShardedDataStatus

If this was an operation that included rebalancing sharded data, the rebalancing-specific status of the operation.

Valid values are:

Definition at line 409 of file admin_show_cluster_operations.h.

◆ rebalanceUnshardedData

bool gpudb::AdminShowClusterOperationsResponse::rebalanceUnshardedData

Whether rebalancing of unsharded data is (or was) part of this operation.

Supported values:

  • true
  • false

Definition at line 347 of file admin_show_cluster_operations.h.

◆ rebalanceUnshardedDataStatus

std::string gpudb::AdminShowClusterOperationsResponse::rebalanceUnshardedDataStatus

If this was an operation that included rebalancing unsharded data, the rebalancing-specific status of the operation.

Valid values are:

Definition at line 366 of file admin_show_cluster_operations.h.

◆ removeRanks

bool gpudb::AdminShowClusterOperationsResponse::removeRanks

Whether removing ranks is (or was) part of this operation.

Supported values:

  • true
  • false

Definition at line 295 of file admin_show_cluster_operations.h.

◆ removeRanksPercentComplete

int32_t gpudb::AdminShowClusterOperationsResponse::removeRanksPercentComplete

Current percent complete of the remove ranks operation.

Definition at line 325 of file admin_show_cluster_operations.h.

◆ removeRanksStatus

std::string gpudb::AdminShowClusterOperationsResponse::removeRanksStatus

◆ shardArrayVersion

int64_t gpudb::AdminShowClusterOperationsResponse::shardArrayVersion

Version of the shard array that is (or was) being rebalanced to.

Each change to the shard array results in the version number incrementing.

Definition at line 390 of file admin_show_cluster_operations.h.

◆ shardedRebalancePercentComplete

int32_t gpudb::AdminShowClusterOperationsResponse::shardedRebalancePercentComplete

Percentage of shard keys, and their associated data if applicable, that have completed rebalancing.

Definition at line 420 of file admin_show_cluster_operations.h.

◆ startTime

std::string gpudb::AdminShowClusterOperationsResponse::startTime

The start time of the cluster operation.

Definition at line 178 of file admin_show_cluster_operations.h.

◆ unshardedRebalancePercentComplete

int32_t gpudb::AdminShowClusterOperationsResponse::unshardedRebalancePercentComplete

Percentage of unsharded tables that completed rebalancing, out of all unsharded tables to rebalance.

Definition at line 372 of file admin_show_cluster_operations.h.

◆ userStopped

bool gpudb::AdminShowClusterOperationsResponse::userStopped

Whether a user stopped this operation at any point while in progress.

Supported values:

  • true
  • false

Definition at line 219 of file admin_show_cluster_operations.h.


The documentation for this struct was generated from the following file: