Kinetica   C#   API  Version 7.2.3.1
RevokePermissionDirectoryRequest Class Reference

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

+ Inheritance diagram for RevokePermissionDirectoryRequest:
+ Collaboration diagram for RevokePermissionDirectoryRequest:

Classes

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

Public Member Functions

 RevokePermissionDirectoryRequest ()
 Constructs a RevokePermissionDirectoryRequest object with default parameters. More...
 
 RevokePermissionDirectoryRequest (string name, string permission, string directory_name, IDictionary< string, string > options=null)
 Constructs a RevokePermissionDirectoryRequest object with the specified parameters. More...
 
- Public Member Functions inherited from 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 from which the permission will be revoked. More...
 
string permission [get, set]
 Permission to revoke from the user or role. More...
 
string directory_name [get, set]
 Name of the KiFS directory to which the permission revokes access. More...
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters. More...
 
- Properties inherited from KineticaData
Schema Schema [get]
 Avro Schema for this class More...
 
- Properties inherited from Avro.Specific.ISpecificRecord
Schema Schema [get]
 

Additional Inherited Members

- Static Public Member Functions inherited from 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.revokePermissionDirectory.

Revokes a KiFS directory-level permission from a user or role.

Definition at line 17 of file RevokePermissionDirectory.cs.

Constructor & Destructor Documentation

◆ RevokePermissionDirectoryRequest() [1/2]

RevokePermissionDirectoryRequest.RevokePermissionDirectoryRequest ( )
inline

Constructs a RevokePermissionDirectoryRequest object with default parameters.

Definition at line 72 of file RevokePermissionDirectory.cs.

◆ RevokePermissionDirectoryRequest() [2/2]

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

Constructs a RevokePermissionDirectoryRequest object with the specified parameters.

Parameters
nameName of the user or role from which the permission will be revoked. Must be an existing user or role.
permissionPermission to revoke from 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 revokes access.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 101 of file RevokePermissionDirectory.cs.

Property Documentation

◆ directory_name

string RevokePermissionDirectoryRequest.directory_name
getset

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

Definition at line 63 of file RevokePermissionDirectory.cs.

◆ name

string RevokePermissionDirectoryRequest.name
getset

Name of the user or role from which the permission will be revoked.

Must be an existing user or role.

Definition at line 39 of file RevokePermissionDirectory.cs.

◆ options

IDictionary<string, string> RevokePermissionDirectoryRequest.options = new Dictionary<string, string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 68 of file RevokePermissionDirectory.cs.

◆ permission

string RevokePermissionDirectoryRequest.permission
getset

Permission to revoke from 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 59 of file RevokePermissionDirectory.cs.


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