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

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

#include <gpudb/protocol/revoke_permission.h>

Public Member Functions

 RevokePermissionRequest ()
 Constructs a RevokePermissionRequest object with default parameters. More...
 
 RevokePermissionRequest (const std::string &principal_, const std::string &object_, const std::string &objectType_, const std::string &permission_, const std::map< std::string, std::string > &options_)
 Constructs a RevokePermissionRequest object with the specified parameters. More...
 

Public Attributes

std::string principal
 Name of the user or role for which the permission is being revoked. More...
 
std::string object
 Name of object permission is being revoked from. More...
 
std::string objectType
 The type of object being revoked. More...
 
std::string permission
 Permission being revoked. More...
 
std::map< std::string, std::string > options
 Optional parameters. More...
 

Detailed Description

A set of parameters for GPUdb::revokePermission.

Revoke user or role the specified permission on the specified object.

Definition at line 18 of file revoke_permission.h.

Constructor & Destructor Documentation

◆ RevokePermissionRequest() [1/2]

gpudb::RevokePermissionRequest::RevokePermissionRequest ( )
inline

Constructs a RevokePermissionRequest object with default parameters.

Definition at line 23 of file revoke_permission.h.

◆ RevokePermissionRequest() [2/2]

gpudb::RevokePermissionRequest::RevokePermissionRequest ( const std::string &  principal_,
const std::string &  object_,
const std::string &  objectType_,
const std::string &  permission_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs a RevokePermissionRequest object with the specified parameters.

Parameters
[in]principal_Name of the user or role for which the permission is being revoked. Must be an existing user or role. The default value is ''.
[in]object_Name of object permission is being revoked from. It is recommended to use a fully-qualified name when possible.
[in]objectType_The type of object being revoked. Supported values:
[in]permission_Permission being revoked. Supported values:
[in]options_Optional parameters. The default value is an empty map.

Definition at line 139 of file revoke_permission.h.

Member Data Documentation

◆ object

std::string gpudb::RevokePermissionRequest::object

Name of object permission is being revoked from.

It is recommended to use a fully-qualified name when possible.

Definition at line 158 of file revoke_permission.h.

◆ objectType

std::string gpudb::RevokePermissionRequest::objectType

The type of object being revoked.

Supported values:

Definition at line 190 of file revoke_permission.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 235 of file revoke_permission.h.

◆ permission

std::string gpudb::RevokePermissionRequest::permission

Permission being revoked.

Supported values:

Definition at line 224 of file revoke_permission.h.

◆ principal

std::string gpudb::RevokePermissionRequest::principal

Name of the user or role for which the permission is being revoked.

Must be an existing user or role. The default value is ''.

Definition at line 152 of file revoke_permission.h.


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