Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.HasPermissionRequest Class Reference

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

+ Inheritance diagram for kinetica.HasPermissionRequest:
+ Collaboration diagram for kinetica.HasPermissionRequest:

Classes

struct  ObjectType
 The type of object being checked Supported values:

A set of string constants for the parameter object_type. More...

 
struct  Options
 Optional parameters. More...
 
struct  Permission
 Permission to check for. 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 Supported values:

More...
 
string permission [get, set]
 Permission to check for. 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.hasPermission(string,string,string,string,IDictionary{string, string}).


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

Definition at line 20 of file HasPermission.cs.

Constructor & Destructor Documentation

kinetica.HasPermissionRequest.HasPermissionRequest ( )
inline

Constructs a HasPermissionRequest object with default parameters.

Definition at line 438 of file HasPermission.cs.

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
principalName 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 ''.
_objectName of object to check for the requested permission. It is recommended to use a fully-qualified name when possible.
object_typeThe type of object being checked Supported values:
permissionPermission 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.
  • 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.
optionsOptional 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_permission">. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 594 of file HasPermission.cs.

Property Documentation

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 283 of file HasPermission.cs.

string kinetica.HasPermissionRequest.object_type
getset

The type of object being checked Supported values:

Definition at line 349 of file HasPermission.cs.

IDictionary<string, string> kinetica.HasPermissionRequest.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_permission">. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 433 of file HasPermission.cs.

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.
  • 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 406 of file HasPermission.cs.

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 278 of file HasPermission.cs.


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