Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Classes | Public Member Functions | Properties | List of all members
kinetica.RevokePermissionRequest Class Reference

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

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

Classes

struct  ObjectType
 The type of object being revoked Supported values:

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

 
struct  Options
 Optional parameters. More...
 
struct  Permission
 Permission being revoked. More...
 

Public Member Functions

 RevokePermissionRequest ()
 Constructs a RevokePermissionRequest object with default parameters. More...
 
 RevokePermissionRequest (string principal, string _object, string object_type, string permission, IDictionary< string, string > options=null)
 Constructs a RevokePermissionRequest 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 or role for which the permission is being revoked. More...
 
string _object = "" [get, set]
 Name of object permission is being revoked from. More...
 
string object_type [get, set]
 The type of object being revoked Supported values:

More...
 
string permission [get, set]
 Permission being revoked. 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.revokePermission(string,string,string,string,IDictionary{string, string}).


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

Definition at line 20 of file RevokePermission.cs.

Constructor & Destructor Documentation

kinetica.RevokePermissionRequest.RevokePermissionRequest ( )
inline

Constructs a RevokePermissionRequest object with default parameters.

Definition at line 391 of file RevokePermission.cs.

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

Constructs a RevokePermissionRequest object with the specified parameters.

Parameters
principalName of the user or role for which the permission is being revoked. Must be an existing user or role. The default value is ''.
_objectName of object permission is being revoked from. It is recommended to use a fully-qualified name when possible.
object_typeThe type of object being revoked Supported values:
permissionPermission being revoked. 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.
  • COLUMNS: Revoke table security from these columns, comma-separated. The default value is ''.
The default value is an empty Dictionary.

Definition at line 532 of file RevokePermission.cs.

Property Documentation

string kinetica.RevokePermissionRequest._object = ""
getset

Name of object permission is being revoked from.

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

Definition at line 251 of file RevokePermission.cs.

string kinetica.RevokePermissionRequest.object_type
getset

The type of object being revoked Supported values:

Definition at line 317 of file RevokePermission.cs.

IDictionary<string, string> kinetica.RevokePermissionRequest.options
getset

Optional parameters.

  • COLUMNS: Revoke table security from these columns, comma-separated. The default value is ''.

The default value is an empty Dictionary.

Definition at line 386 of file RevokePermission.cs.

string kinetica.RevokePermissionRequest.permission
getset

Permission being revoked.

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 374 of file RevokePermission.cs.

string kinetica.RevokePermissionRequest.principal
getset

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

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

Definition at line 246 of file RevokePermission.cs.

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