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

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

#include <gpudb/protocol/show_credential.h>

Public Member Functions

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

Public Attributes

std::string credentialName
 Name of the credential on which to retrieve information. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::showCredential.

Shows information about a specified credential or all credentials.

Definition at line 20 of file show_credential.h.

Constructor & Destructor Documentation

◆ ShowCredentialRequest() [1/2]

gpudb::ShowCredentialRequest::ShowCredentialRequest ( )
inline

Constructs a ShowCredentialRequest object with default parameters.

Definition at line 25 of file show_credential.h.

◆ ShowCredentialRequest() [2/2]

gpudb::ShowCredentialRequest::ShowCredentialRequest ( const std::string &  credentialName_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a ShowCredentialRequest object with the specified parameters.

Parameters
[in]credentialName_Name of the credential on which to retrieve information. The name must refer to a currently existing credential. If '*' is specified, information about all credentials will be returned.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 44 of file show_credential.h.

Member Data Documentation

◆ credentialName

std::string gpudb::ShowCredentialRequest::credentialName

Name of the credential on which to retrieve information.

The name must refer to a currently existing credential. If '*' is specified, information about all credentials will be returned.

Definition at line 55 of file show_credential.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 60 of file show_credential.h.


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