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

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

#include <gpudb/protocol/grant_permission_directory.h>

Public Member Functions

 GrantPermissionDirectoryRequest ()
 Constructs a GrantPermissionDirectoryRequest object with default parameters. More...
 
 GrantPermissionDirectoryRequest (const std::string &name_, const std::string &permission_, const std::string &directoryName_, const std::map< std::string, std::string > &options_)
 Constructs a GrantPermissionDirectoryRequest 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 directoryName
 Name of the KiFS directory to which the permission grants access. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::grantPermissionDirectory.

Grants a KiFS directory-level permission to a user or role.

Definition at line 19 of file grant_permission_directory.h.

Constructor & Destructor Documentation

◆ GrantPermissionDirectoryRequest() [1/2]

gpudb::GrantPermissionDirectoryRequest::GrantPermissionDirectoryRequest ( )
inline

Constructs a GrantPermissionDirectoryRequest object with default parameters.

Definition at line 25 of file grant_permission_directory.h.

◆ GrantPermissionDirectoryRequest() [2/2]

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

Constructs a GrantPermissionDirectoryRequest 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]directoryName_Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories
[in]options_Optional parameters. The default value is an empty map.

Definition at line 63 of file grant_permission_directory.h.

Member Data Documentation

◆ directoryName

std::string gpudb::GrantPermissionDirectoryRequest::directoryName

Name of the KiFS directory to which the permission grants access.

An empty directory name grants access to all KiFS directories

Definition at line 97 of file grant_permission_directory.h.

◆ name

std::string gpudb::GrantPermissionDirectoryRequest::name

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

Must be an existing user or role.

Definition at line 75 of file grant_permission_directory.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 102 of file grant_permission_directory.h.

◆ permission

std::string gpudb::GrantPermissionDirectoryRequest::permission

Permission to grant to the user or role.

Supported values:

Definition at line 91 of file grant_permission_directory.h.


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