GPUdb C++ API  Version 5.2.0.0
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 GPUdb server application.

Definition at line 18 of file admin_shutdown.h.

Constructor & Destructor Documentation

gpudb::AdminShutdownRequest::AdminShutdownRequest ( )
inline

Constructs an AdminShutdownRequest object with default parameter values.

Definition at line 25 of file admin_shutdown.h.

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]exitTypeReserved for future use. User can pass an empty string.
[in]authorizationNo longer used. User can pass an empty string.
[in]optionsOptional parameters. Default value is an empty std::map.

Definition at line 44 of file admin_shutdown.h.

Member Data Documentation

std::string gpudb::AdminShutdownRequest::authorization

Definition at line 52 of file admin_shutdown.h.

std::string gpudb::AdminShutdownRequest::exitType

Definition at line 51 of file admin_shutdown.h.

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

Definition at line 53 of file admin_shutdown.h.


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