> ## Documentation Index > Fetch the complete documentation index at: https://docs.kinetica.com/llms.txt > Use this file to discover all available pages before exploring further. # kinetica.GrantPermissionRequest > kinetica.GrantPermissionRequest — Kinetica C# API

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

Inheritance diagram for kinetica.GrantPermissionRequest:
Collaboration diagram for kinetica.GrantPermissionRequest:

Classes
struct   ObjectType
  A set of string constants for the parameter GrantPermissionRequest.object\_type. More...
 
struct   Options
  A set of string constants for the parameter GrantPermissionRequest.options. More...
 
struct   Permission
  A set of string constants for the parameter GrantPermissionRequest.permission. More...
 

Public Member Functions
  GrantPermissionRequest ()
  Constructs a GrantPermissionRequest object with default parameters.
 
  GrantPermissionRequest (string principal, string \_object, string object\_type, string permission, IDictionary\< string, string > options=null)
  Constructs a GrantPermissionRequest object with the specified parameters.
 
  GrantPermissionRequest ()
  Constructs a GrantPermissionRequest object with default parameters.
 
  GrantPermissionRequest (string principal, string \_object, string object\_type, string permission, IDictionary\< string, string > options=null)
  Constructs a GrantPermissionRequest 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 or role for which the permission is being granted.
 
string  \_object \[get, set]
  Name of object permission is being granted to.
 
string  object\_type \[get, set]
  The type of object being granted to.
 
string  permission \[get, set]
  Permission being granted.
 
IDictionary\< string, string >  options = new Dictionary\() \[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.grantPermission.

Grant user or role the specified permission on the specified object.

Definition at line 16 of file GrantPermission.cs.

Constructor & Destructor Documentation

◆ GrantPermissionRequest() \[1/4]

kinetica.GrantPermissionRequest.GrantPermissionRequest ( )
inline

Constructs a GrantPermissionRequest object with default parameters.

Definition at line 378 of file GrantPermission.cs.

◆ GrantPermissionRequest() \[2/4]

kinetica.GrantPermissionRequest.GrantPermissionRequest ( string principal,
string \_object,
string object\_type,
string permission,
IDictionary\< string, string > options = null )
inline

Constructs a GrantPermissionRequest object with the specified parameters.

Parameters
principal Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''.
\_object Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible.
object\_type The type of object being granted to. Supported values:
permission Permission being granted. 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.
  • MONITOR: Monitor logs and statistics.
  • READ: Ability to read, list and use the object.
  • SEND\_ALERT: Ability to send system alerts.
  • 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.
  • COLUMNS: Apply table security to these columns, comma-separated. The default value is ''.
  • FILTER\_EXPRESSION: Filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
  • WITH\_GRANT\_OPTION: Allow the recipient to grant the same permission (or subset) to others. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 595 of file GrantPermission.cs.

◆ GrantPermissionRequest() \[3/4]

kinetica.GrantPermissionRequest.GrantPermissionRequest ( )
inline

Constructs a GrantPermissionRequest object with default parameters.

Definition at line 378 of file GrantPermission.cs.

◆ GrantPermissionRequest() \[4/4]

kinetica.GrantPermissionRequest.GrantPermissionRequest ( string principal,
string \_object,
string object\_type,
string permission,
IDictionary\< string, string > options = null )
inline

Constructs a GrantPermissionRequest object with the specified parameters.

Parameters
principal Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''.
\_object Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible.
object\_type The type of object being granted to. Supported values:
permission Permission being granted. 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.
  • MONITOR: Monitor logs and statistics.
  • READ: Ability to read, list and use the object.
  • SEND\_ALERT: Ability to send system alerts.
  • 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.
  • COLUMNS: Apply table security to these columns, comma-separated. The default value is ''.
  • FILTER\_EXPRESSION: Filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
  • WITH\_GRANT\_OPTION: Allow the recipient to grant the same permission (or subset) to others. Supported values: The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 595 of file GrantPermission.cs.

Property Documentation

◆ \_object

string kinetica.GrantPermissionRequest.\_object
getset

Name of object permission is being granted to.

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

Definition at line 161 of file GrantPermission.cs.

◆ object\_type

string kinetica.GrantPermissionRequest.object\_type
getset

The type of object being granted to.

Supported values:

Definition at line 245 of file GrantPermission.cs.

◆ options

IDictionary\< string, string > kinetica.GrantPermissionRequest.options = new Dictionary\()
getset

Optional parameters.

  • COLUMNS: Apply table security to these columns, comma-separated. The default value is ''.
  • FILTER\_EXPRESSION: Filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
  • WITH\_GRANT\_OPTION: Allow the recipient to grant the same permission (or subset) to others. Supported values: The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 374 of file GrantPermission.cs.

◆ permission

string kinetica.GrantPermissionRequest.permission
getset

Permission being granted.

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.
  • MONITOR: Monitor logs and statistics.
  • READ: Ability to read, list and use the object.
  • SEND\_ALERT: Ability to send system alerts.
  • 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 330 of file GrantPermission.cs.

◆ principal

string kinetica.GrantPermissionRequest.principal = ""
getset

Name of the user or role for which the permission is being granted.

Must be an existing user or role. The default value is ''.

Definition at line 156 of file GrantPermission.cs.

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