HasRoleRequest Class Reference
A set of parameters for Kinetica.hasRole. More...
Inheritance diagram for HasRoleRequest:
Collaboration diagram for HasRoleRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| HasRoleRequest () | |
| Constructs a HasRoleRequest object with default parameters. More... | |
| HasRoleRequest (string principal, string role, IDictionary< string, string > options=null) | |
| Constructs a HasRoleRequest object with the specified parameters. More... | |
| Public Member Functions inherited from KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | principal = "" [get, set] |
| Name of the user for which role membership is being checked. More... | |
| string | role [get, set] |
| Name of role to check for membership. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
| Properties inherited from Avro.Specific.ISpecificRecord | |
| Schema | Schema [get] |
Additional Inherited Members | |
| Static Public Member Functions inherited from KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.hasRole.
Checks if the specified user has the specified role.
Definition at line 15 of file HasRole.cs.
Constructor & Destructor Documentation
◆ HasRoleRequest() [1/2]
|
inline |
Constructs a HasRoleRequest object with default parameters.
Definition at line 116 of file HasRole.cs.
◆ HasRoleRequest() [2/2]
|
inline |
Constructs a HasRoleRequest object with the specified parameters.
- Parameters
-
principal Name of the user for which role membership is being checked. Must be an existing user. If blank, will use the current user. The default value is ''. role Name of role to check for membership. options Optional parameters. - 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 has_role. Supported values: The default value is FALSE.
- 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: The default value is FALSE.
Definition at line 170 of file HasRole.cs.
Property Documentation
◆ options
|
getset |
Optional parameters.
- 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 has_role. Supported values: The default value is FALSE.
- 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: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 112 of file HasRole.cs.
◆ principal
|
getset |
Name of the user for which role membership is being checked.
Must be an existing user. If blank, will use the current user. The default value is ''.
Definition at line 62 of file HasRole.cs.
◆ role
|
getset |
Name of role to check for membership.
Definition at line 65 of file HasRole.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/HasRole.cs
