A set of parameters for Kinetica.hasRole. More…
Inheritance diagram for kinetica.HasRoleRequest:
[legend]
Collaboration diagram for kinetica.HasRoleRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter HasRoleRequest.options. More… | |
Public Member Functions | |
| HasRoleRequest () | |
| Constructs a HasRoleRequest object with default parameters. | |
| HasRoleRequest (string principal, string role, IDictionary< string, string > options=null) | |
| Constructs a HasRoleRequest object with the specified parameters. | |
| HasRoleRequest () | |
| Constructs a HasRoleRequest object with default parameters. | |
| HasRoleRequest (string principal, string role, IDictionary< string, string > options=null) | |
| Constructs a HasRoleRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | principal = "" [get, set] |
| Name of the user for which role membership is being checked. | |
| string | role [get, set] |
| Name of role to check for membership. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
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/4]
| inline |
Constructs a HasRoleRequest object with default parameters.
Definition at line 142 of file HasRole.cs.
◆ HasRoleRequest() [2/4]
| 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.
|
Definition at line 205 of file HasRole.cs.
◆ HasRoleRequest() [3/4]
| inline |
Constructs a HasRoleRequest object with default parameters.
Definition at line 142 of file HasRole.cs.
◆ HasRoleRequest() [4/4]
| 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.
|
Definition at line 205 of file HasRole.cs.
Property Documentation
◆ options
| getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided HasRoleRequest.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 HasRoleRequest.principal is a member of HasRoleRequest.role. If TRUE then HasRoleRequest.principal must directly be a member of HasRoleRequest.role. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 138 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 79 of file HasRole.cs.
◆ role
| getset |
Name of role to check for membership.
Definition at line 82 of file HasRole.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/HasRole.cs
- Kinetica/Protocol/HasRole.cs