A set of parameters for Kinetica.hasRole(string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.HasRoleRequest:

Collaboration diagram for kinetica.HasRoleRequest:

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 kinetica.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 membersih is being checked. More...

string	role = "" `[get, set]`
	Name of role to check for membership. More...

IDictionary< string, string >	options `[get, set]`
	Optional parameters. More...

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class More...

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. More...

Detailed Description

A set of parameters for Kinetica.hasRole(string,string,IDictionary{string, string}).

Checks if the specified user has the specified role.

Definition at line 19 of file HasRole.cs.

Constructor & Destructor Documentation

kinetica.HasRoleRequest.HasRoleRequest ( )

inline

Constructs a HasRoleRequest object with default parameters.

Definition at line 176 of file HasRole.cs.

kinetica.HasRoleRequest.HasRoleRequest	(	string	principal,
		string	role,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a HasRoleRequest object with the specified parameters.

Parameters

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 ''.
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 does not exist or is blank. If true then it will return false for <member name="has_role">. Supported values: TRUE FALSE The default value is FALSE. ONLY_DIRECT: If false will search recursively if the is a member of . If true then must directly be a member of . Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 233 of file HasRole.cs.

IDictionary<string, string> kinetica.HasRoleRequest.options

getset

Optional parameters.

NO_ERROR_IF_NOT_EXISTS: If false will return an error if the provided does not exist or is blank. If true then it will return false for <member name="has_role">. Supported values:
- TRUE
- FALSE
The default value is FALSE.
ONLY_DIRECT: If false will search recursively if the is a member of . If true then must directly be a member of . Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 171 of file HasRole.cs.

string kinetica.HasRoleRequest.principal

getset

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 119 of file HasRole.cs.

string kinetica.HasRoleRequest.role = ""

getset

Name of role to check for membership.

Definition at line 122 of file HasRole.cs.

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