gpudb::AdminShutdownRequest Struct Reference

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

#include <gpudb/protocol/admin_shutdown.h>

Public Member Functions
	AdminShutdownRequest ()
	Constructs an AdminShutdownRequest object with default parameters. More...
	AdminShutdownRequest (const std::string &exitType_, const std::string &authorization_, const std::map< std::string, std::string > &options_)
	Constructs an AdminShutdownRequest object with the specified parameters. More...

Public Attributes
std::string	exitType
	Reserved for future use. More...
std::string	authorization
	No longer used. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::adminShutdown.

Exits the database server application.

Definition at line 18 of file admin_shutdown.h.

Constructor & Destructor Documentation

AdminShutdownRequest() [1/2]

gpudb::AdminShutdownRequest::AdminShutdownRequest ( )

inline

Constructs an AdminShutdownRequest object with default parameters.

Definition at line 23 of file admin_shutdown.h.

AdminShutdownRequest() [2/2]

gpudb::AdminShutdownRequest::AdminShutdownRequest ( const std::string &  exitType_, const std::string &  authorization_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AdminShutdownRequest object with the specified parameters.

Parameters

[in]	exitType_	Reserved for future use. User can pass an empty string.
[in]	authorization_	No longer used. User can pass an empty string.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 41 of file admin_shutdown.h.

Member Data Documentation

authorization

std::string gpudb::AdminShutdownRequest::authorization

No longer used.

User can pass an empty string.

Definition at line 56 of file admin_shutdown.h.

exitType

std::string gpudb::AdminShutdownRequest::exitType

Reserved for future use.

User can pass an empty string.

Definition at line 51 of file admin_shutdown.h.

options

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

Optional parameters.

The default value is an empty map.

Definition at line 61 of file admin_shutdown.h.

---

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

• gpudb/protocol/admin_shutdown.h