Skip to main content

A set of parameters for GPUdb::adminOffline. More…

#include <gpudb/protocol/admin_offline.h>

​
Public Member Functions

 AdminOfflineRequest ()
 Constructs an AdminOfflineRequest object with default parameters.
 
 AdminOfflineRequest (const bool offline_, const std::map< std::string, std::string > &options_)
 Constructs an AdminOfflineRequest object with the specified parameters.
 

​
Public Attributes

bool offline
 Set to true if desired state is offline.
 
std::map< std::string, std::string > options
 Optional parameters.
 

​
Detailed Description

A set of parameters for GPUdb::adminOffline.

Take the system offline. When the system is offline, no user operations can be performed with the exception of a system shutdown.

Definition at line 19 of file admin_offline.h.

​
Constructor & Destructor Documentation

​
◆ AdminOfflineRequest() [1/2]

gpudb::AdminOfflineRequest::AdminOfflineRequest ()
 inline

Constructs an AdminOfflineRequest object with default parameters.

Definition at line 24 of file admin_offline.h.

​
◆ AdminOfflineRequest() [2/2]

gpudb::AdminOfflineRequest::AdminOfflineRequest (const booloffline_,
const std::map< std::string, std::string > &options_ )
 inline

Constructs an AdminOfflineRequest object with the specified parameters.

Parameters
[in]offline_Set to true if desired state is offline. Supported values:
  • true
  • false
[in]options_Optional parameters.The default value is an empty map.

Definition at line 55 of file admin_offline.h.

​
Member Data Documentation

​
◆ offline

bool gpudb::AdminOfflineRequest::offline

Set to true if desired state is offline.

Supported values:

  • true
  • false

Definition at line 69 of file admin_offline.h.

​
◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 86 of file admin_offline.h.

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