A set of parameters for Kinetica.hasPermission. More...

Inheritance diagram for kinetica.HasPermissionRequest:

Collaboration diagram for kinetica.HasPermissionRequest:

Classes
struct	ObjectType
	A set of string constants for the parameter object_type. More...

struct	Options
	A set of string constants for the parameter options. More...

struct	Permission
	A set of string constants for the parameter permission. More...

Public Member Functions
	HasPermissionRequest ()
	Constructs a HasPermissionRequest object with default parameters. More...

	HasPermissionRequest (string principal, string _object, string object_type, string permission, IDictionary< string, string > options=null)
	Constructs a HasPermissionRequest 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 the permission is being checked. More...

string	_object `[get, set]`
	Name of object to check for the requested permission. More...

string	object_type `[get, set]`
	The type of object being checked. More...

string	permission `[get, set]`
	Permission to check for. More...

IDictionary< string, string >	options = new Dictionary<string, string>() `[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.hasPermission.

Checks if the specified user has the specified permission on the specified object.

Definition at line 16 of file HasPermission.cs.

Constructor & Destructor Documentation

◆ HasPermissionRequest() [1/2]

kinetica.HasPermissionRequest.HasPermissionRequest ( )

inline

Constructs a HasPermissionRequest object with default parameters.

Definition at line 281 of file HasPermission.cs.

◆ HasPermissionRequest() [2/2]

kinetica.HasPermissionRequest.HasPermissionRequest	(	string	principal,
		string	_object,
		string	object_type,
		string	permission,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a HasPermissionRequest object with the specified parameters.

Parameters

principal	Name of the user for which the permission is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.
_object	Name of object to check for the requested permission. It is recommended to use a fully-qualified name when possible.
object_type	The type of object being checked. Supported values: CONTEXT: Context CREDENTIAL: Credential DATASINK: Data Sink DATASOURCE: Data Source DIRECTORY: KiFS File Directory GRAPH: A Graph object PROC: UDF Procedure SCHEMA: Schema SQL_PROC: SQL Procedure SYSTEM: System-level access TABLE: Database Table TABLE_MONITOR: Table monitor
permission	Permission to check for. Supported values: ADMIN: Full read/write and administrative access on the object. CONNECT: Connect access on the given data source or data sink. CREATE: Ability to create new objects of this type. DELETE: Delete rows from tables. EXECUTE: Ability to Execute the Procedure object. INSERT: Insert access to tables. READ: Ability to read, list and use the object. UPDATE: Update access to the table. USER_ADMIN: Access to administer users and roles that do not have system_admin permission. WRITE: Access to write, change and delete objects.
options	Optional parameters. NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided _object does not exist or is blank. If TRUE then it will return FALSE for has_permission. Supported values: TRUE FALSE The default value is FALSE. The default value is an empty Dictionary.

Definition at line 429 of file HasPermission.cs.

Property Documentation

◆ _object

string kinetica.HasPermissionRequest._object

getset

Name of object to check for the requested permission.

It is recommended to use a fully-qualified name when possible.

Definition at line 134 of file HasPermission.cs.

◆ object_type

string kinetica.HasPermissionRequest.object_type

getset

The type of object being checked.

Supported values:

CONTEXT: Context
CREDENTIAL: Credential
DATASINK: Data Sink
DATASOURCE: Data Source
DIRECTORY: KiFS File Directory
GRAPH: A Graph object
PROC: UDF Procedure
SCHEMA: Schema
SQL_PROC: SQL Procedure
SYSTEM: System-level access
TABLE: Database Table
TABLE_MONITOR: Table monitor

Definition at line 194 of file HasPermission.cs.

◆ options

IDictionary<string, string> kinetica.HasPermissionRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

NO_ERROR_IF_NOT_EXISTS: If FALSE will return an error if the provided _object does not exist or is blank. If TRUE then it will return FALSE for has_permission. Supported values:
- TRUE
- FALSE
The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 277 of file HasPermission.cs.

◆ permission

string kinetica.HasPermissionRequest.permission

getset

Permission to check for.

Supported values:

ADMIN: Full read/write and administrative access on the object.
CONNECT: Connect access on the given data source or data sink.
CREATE: Ability to create new objects of this type.
DELETE: Delete rows from tables.
EXECUTE: Ability to Execute the Procedure object.
INSERT: Insert access to tables.
READ: Ability to read, list and use the object.
UPDATE: Update access to the table.
USER_ADMIN: Access to administer users and roles that do not have system_admin permission.
WRITE: Access to write, change and delete objects.

Definition at line 248 of file HasPermission.cs.

◆ principal

string kinetica.HasPermissionRequest.principal = ""

getset

Name of the user for which the permission is being checked.

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

Definition at line 128 of file HasPermission.cs.

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

Kinetica/Protocol/HasPermission.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ HasPermissionRequest() [1/2]

◆ HasPermissionRequest() [2/2]

Property Documentation

◆ _object

◆ object_type

◆ options

◆ permission

◆ principal