GPUdb C++ API  Version 6.2.0.3
gpudb::AdminShutdownRequest Struct Reference

A set of input parameters for adminShutdown(const AdminShutdownRequest&) const. More...

#include <gpudb/protocol/admin_shutdown.h>

Public Member Functions

 AdminShutdownRequest ()
 Constructs an AdminShutdownRequest object with default parameter values. 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
 
std::string authorization
 
std::map< std::string, std::string > options
 

Detailed Description

A set of input parameters for adminShutdown(const AdminShutdownRequest&) const.

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 parameter values.

Definition at line 25 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.

Definition at line 43 of file admin_shutdown.h.

Member Data Documentation

◆ authorization

std::string gpudb::AdminShutdownRequest::authorization

Definition at line 51 of file admin_shutdown.h.

◆ exitType

std::string gpudb::AdminShutdownRequest::exitType

Definition at line 50 of file admin_shutdown.h.

◆ options

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

Definition at line 52 of file admin_shutdown.h.


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