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

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

#include <gpudb/protocol/revoke_permission_credential.h>

Public Member Functions

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

Public Attributes

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

Detailed Description

A set of parameters for GPUdb::revokePermissionCredential.

Revokes a credential-level permission from a user or role.

Definition at line 20 of file revoke_permission_credential.h.

Constructor & Destructor Documentation

◆ RevokePermissionCredentialRequest() [1/2]

gpudb::RevokePermissionCredentialRequest::RevokePermissionCredentialRequest ( )
inline

Constructs a RevokePermissionCredentialRequest object with default parameters.

Definition at line 26 of file revoke_permission_credential.h.

◆ RevokePermissionCredentialRequest() [2/2]

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

Constructs a RevokePermissionCredentialRequest object with the specified parameters.

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

Definition at line 61 of file revoke_permission_credential.h.

Member Data Documentation

◆ credentialName

std::string gpudb::RevokePermissionCredentialRequest::credentialName

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

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

Definition at line 94 of file revoke_permission_credential.h.

◆ name

std::string gpudb::RevokePermissionCredentialRequest::name

Name of the user or role from which the permission will be revoked.

Must be an existing user or role.

Definition at line 73 of file revoke_permission_credential.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 99 of file revoke_permission_credential.h.

◆ permission

std::string gpudb::RevokePermissionCredentialRequest::permission

Permission to revoke from the user or role.

Supported values:

Definition at line 87 of file revoke_permission_credential.h.


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