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

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

#include <gpudb/protocol/grant_permission_credential.h>

Public Member Functions

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

Public Attributes

std::string name
 Name of the user or role to which the permission will be granted. More...
 
std::string permission
 Permission to grant to the user or role. More...
 
std::string credentialName
 Name of the credential on which the permission will be granted. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::grantPermissionCredential.

Grants a credential-level permission to a user or role.

Definition at line 20 of file grant_permission_credential.h.

Constructor & Destructor Documentation

◆ GrantPermissionCredentialRequest() [1/2]

gpudb::GrantPermissionCredentialRequest::GrantPermissionCredentialRequest ( )
inline

Constructs a GrantPermissionCredentialRequest object with default parameters.

Definition at line 26 of file grant_permission_credential.h.

◆ GrantPermissionCredentialRequest() [2/2]

gpudb::GrantPermissionCredentialRequest::GrantPermissionCredentialRequest ( const std::string &  name_,
const std::string &  permission_,
const std::string &  credentialName_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a GrantPermissionCredentialRequest object with the specified parameters.

Parameters
[in]name_Name of the user or role to which the permission will be granted. Must be an existing user or role.
[in]permission_Permission to grant to the user or role. Supported values:
[in]credentialName_Name of the credential on which the permission will be granted. Must be an existing credential, or an empty string to grant access on all credentials.
[in]options_Optional parameters. The default value is an empty map.

Definition at line 61 of file grant_permission_credential.h.

Member Data Documentation

◆ credentialName

std::string gpudb::GrantPermissionCredentialRequest::credentialName

Name of the credential on which the permission will be granted.

Must be an existing credential, or an empty string to grant access on all credentials.

Definition at line 94 of file grant_permission_credential.h.

◆ name

std::string gpudb::GrantPermissionCredentialRequest::name

Name of the user or role to which the permission will be granted.

Must be an existing user or role.

Definition at line 73 of file grant_permission_credential.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 99 of file grant_permission_credential.h.

◆ permission

std::string gpudb::GrantPermissionCredentialRequest::permission

Permission to grant to the user or role.

Supported values:

Definition at line 87 of file grant_permission_credential.h.


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