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

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

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

Classes

struct  Permission
 Permission to grant to the user or role. More...
 

Public Member Functions

 GrantPermissionDirectoryRequest ()
 Constructs a GrantPermissionDirectoryRequest object with default parameters. More...
 
 GrantPermissionDirectoryRequest (string name, string permission, string directory_name, IDictionary< string, string > options=null)
 Constructs a GrantPermissionDirectoryRequest 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 name [get, set]
 Name of the user or role to which the permission will be granted. More...
 
string permission [get, set]
 Permission to grant to the user or role. More...
 
string directory_name [get, set]
 Name of the KiFS directory to which the permission grants access. 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.grantPermissionDirectory(string,string,string,IDictionary{string, string}).


Grants a KiFS directory-level permission to a user or role.

Definition at line 20 of file GrantPermissionDirectory.cs.

Constructor & Destructor Documentation

kinetica.GrantPermissionDirectoryRequest.GrantPermissionDirectoryRequest ( )
inline

Constructs a GrantPermissionDirectoryRequest object with default parameters.

Definition at line 93 of file GrantPermissionDirectory.cs.

kinetica.GrantPermissionDirectoryRequest.GrantPermissionDirectoryRequest ( string  name,
string  permission,
string  directory_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a GrantPermissionDirectoryRequest object with the specified parameters.

Parameters
nameName of the user or role to which the permission will be granted. Must be an existing user or role.
permissionPermission to grant to the user or role. Supported values:
  • DIRECTORY_READ: For files in the directory, access to list files, download files, or use files in server side functions
  • DIRECTORY_WRITE: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access
directory_nameName of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 124 of file GrantPermissionDirectory.cs.

Property Documentation

string kinetica.GrantPermissionDirectoryRequest.directory_name
getset

Name of the KiFS directory to which the permission grants access.

An empty directory name grants access to all KiFS directories

Definition at line 84 of file GrantPermissionDirectory.cs.

string kinetica.GrantPermissionDirectoryRequest.name
getset

Name of the user or role to which the permission will be granted.

Must be an existing user or role.

Definition at line 59 of file GrantPermissionDirectory.cs.

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 88 of file GrantPermissionDirectory.cs.

string kinetica.GrantPermissionDirectoryRequest.permission
getset

Permission to grant to the user or role.

Supported values:

  • DIRECTORY_READ: For files in the directory, access to list files, download files, or use files in server side functions
  • DIRECTORY_WRITE: Access to upload files to, or delete files from, the directory. A user or role with write access automatically has read access

Definition at line 79 of file GrantPermissionDirectory.cs.


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