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

A set of parameters for GPUdb::adminShowClusterOperations. More...

#include <gpudb/protocol/admin_show_cluster_operations.h>

Public Member Functions

 AdminShowClusterOperationsRequest ()
 Constructs an AdminShowClusterOperationsRequest object with default parameters. More...
 
 AdminShowClusterOperationsRequest (const int32_t historyIndex_, const std::map< std::string, std::string > &options_)
 Constructs an AdminShowClusterOperationsRequest object with the specified parameters. More...
 

Public Attributes

int32_t historyIndex
 Indicates which cluster operation to retrieve. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::adminShowClusterOperations.

Requests the detailed status of the current operation (by default) or a prior cluster operation specified by historyIndex. Returns details on the requested cluster operation.

The response will also indicate how many cluster operations are stored in the history.

Definition at line 23 of file admin_show_cluster_operations.h.

Constructor & Destructor Documentation

◆ AdminShowClusterOperationsRequest() [1/2]

gpudb::AdminShowClusterOperationsRequest::AdminShowClusterOperationsRequest ( )
inline

Constructs an AdminShowClusterOperationsRequest object with default parameters.

Definition at line 29 of file admin_show_cluster_operations.h.

◆ AdminShowClusterOperationsRequest() [2/2]

gpudb::AdminShowClusterOperationsRequest::AdminShowClusterOperationsRequest ( const int32_t  historyIndex_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AdminShowClusterOperationsRequest object with the specified parameters.

Parameters
[in]historyIndex_Indicates which cluster operation to retrieve. Use 0 for the most recent. The default value is 0.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 45 of file admin_show_cluster_operations.h.

Member Data Documentation

◆ historyIndex

int32_t gpudb::AdminShowClusterOperationsRequest::historyIndex

Indicates which cluster operation to retrieve.

Use 0 for the most recent. The default value is 0.

Definition at line 55 of file admin_show_cluster_operations.h.

◆ options

std::map<std::string, std::string> gpudb::AdminShowClusterOperationsRequest::options

Optional parameters.

The default value is an empty map.

Definition at line 60 of file admin_show_cluster_operations.h.


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