gpudb::HasRoleRequest Struct Reference

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

#include <gpudb/protocol/has_role.h>

Public Member Functions
	HasRoleRequest ()
	Constructs a HasRoleRequest object with default parameters. More...
	HasRoleRequest (const std::string &principal_, const std::string &role_, const std::map< std::string, std::string > &options_)
	Constructs a HasRoleRequest object with the specified parameters. More...

Public Attributes
std::string	principal
	Name of the user for which role membersih is being checked. More...
std::string	role
	Name of role to check for membership. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::hasRole.

Checks if the specified user has the specified role.

Definition at line 17 of file has_role.h.

Constructor & Destructor Documentation

HasRoleRequest() [1/2]

gpudb::HasRoleRequest::HasRoleRequest ( )

inline

Constructs a HasRoleRequest object with default parameters.

Definition at line 22 of file has_role.h.

HasRoleRequest() [2/2]

gpudb::HasRoleRequest::HasRoleRequest ( const std::string &  principal_, const std::string &  role_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a HasRoleRequest object with the specified parameters.

Parameters

[in]	principal_	Name of the user for which role membersih is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.
[in]	role_	Name of role to check for membership.
[in]	options_	Optional parameters. has_role_no_error_if_not_exists: If false will return an error if the provided role_ does not exist or is blank. If true then it will return false for hasRole. Supported values: has_role_true has_role_false The default value is has_role_false. has_role_only_direct: If false will search recursively if the principal_ is a member of role_. If true then principal_ must directly be a member of role_. Supported values: has_role_true has_role_false The default value is has_role_false. The default value is an empty map.

Definition at line 79 of file has_role.h.

Member Data Documentation

options

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

Optional parameters.

• has_role_no_error_if_not_exists: If false will return an error if the provided role does not exist or is blank. If true then it will return false for hasRole. Supported values:
  • has_role_true
  • has_role_false
  The default value is has_role_false.
• has_role_only_direct: If false will search recursively if the principal is a member of role. If true then principal must directly be a member of role. Supported values:
  • has_role_true
  • has_role_false
  The default value is has_role_false.

The default value is an empty map.

Definition at line 130 of file has_role.h.

principal

std::string gpudb::HasRoleRequest::principal

Name of the user for which role membersih is being checked.

Must be an existing user. If blank, will use the current user. The default value is ''.

Definition at line 91 of file has_role.h.

role

std::string gpudb::HasRoleRequest::role

Name of role to check for membership.

Definition at line 96 of file has_role.h.

---

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

• gpudb/protocol/has_role.h