gpudb::AdminOfflineRequest Struct Reference

A set of input parameters for adminOffline(const AdminOfflineRequest&) const. More...

#include <gpudb/protocol/admin_offline.h>

Public Member Functions
	AdminOfflineRequest ()
	Constructs an AdminOfflineRequest object with default parameter values. More...
	AdminOfflineRequest (const bool offline, const std::map< std::string, std::string > &options)
	Constructs an AdminOfflineRequest object with the specified parameters. More...

Public Attributes
bool	offline
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for adminOffline(const AdminOfflineRequest&) const.

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

gpudb::AdminOfflineRequest::AdminOfflineRequest ( )

inline

Constructs an AdminOfflineRequest object with default parameter values.

Definition at line 26 of file admin_offline.h.

gpudb::AdminOfflineRequest::AdminOfflineRequest ( const bool  offline, 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. Values: 'true', 'false'.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 42 of file admin_offline.h.

Member Data Documentation

bool gpudb::AdminOfflineRequest::offline

Definition at line 48 of file admin_offline.h.

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

Definition at line 49 of file admin_offline.h.

---

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

• gpudb/protocol/admin_offline.h