GPUdb C++ API  Version 7.2.2.4
gpudb::ShowSecurityRequest Struct Reference

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

#include <gpudb/protocol/show_security.h>

Public Member Functions

 ShowSecurityRequest ()
 Constructs a ShowSecurityRequest object with default parameters. More...
 
 ShowSecurityRequest (const std::vector< std::string > &names_, const std::map< std::string, std::string > &options_)
 Constructs a ShowSecurityRequest object with the specified parameters. More...
 

Public Attributes

std::vector< std::string > names
 A list of names of users and/or roles about which security information is requested. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showSecurity.

Shows security information relating to users and/or roles. If the caller is not a system administrator, only information relating to the caller and their roles is returned.

Definition at line 20 of file show_security.h.

Constructor & Destructor Documentation

◆ ShowSecurityRequest() [1/2]

gpudb::ShowSecurityRequest::ShowSecurityRequest ( )
inline

Constructs a ShowSecurityRequest object with default parameters.

Definition at line 25 of file show_security.h.

◆ ShowSecurityRequest() [2/2]

gpudb::ShowSecurityRequest::ShowSecurityRequest ( const std::vector< std::string > &  names_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowSecurityRequest object with the specified parameters.

Parameters
[in]names_A list of names of users and/or roles about which security information is requested. If none are provided, information about all users and roles will be returned.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 60 of file show_security.h.

Member Data Documentation

◆ names

std::vector<std::string> gpudb::ShowSecurityRequest::names

A list of names of users and/or roles about which security information is requested.

If none are provided, information about all users and roles will be returned.

Definition at line 71 of file show_security.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 91 of file show_security.h.


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