A set of parameters for Kinetica.grantPermissionDirectory. More…
Classes | |
| struct | Permission |
| A set of string constants for the parameter GrantPermissionDirectoryRequest.permission. More… | |
Public Member Functions | |
| GrantPermissionDirectoryRequest () | |
| Constructs a GrantPermissionDirectoryRequest object with default parameters. | |
| GrantPermissionDirectoryRequest (string name, string permission, string directory_name, IDictionary< string, string > options=null) | |
| Constructs a GrantPermissionDirectoryRequest object with the specified parameters. | |
| GrantPermissionDirectoryRequest () | |
| Constructs a GrantPermissionDirectoryRequest object with default parameters. | |
| GrantPermissionDirectoryRequest (string name, string permission, string directory_name, IDictionary< string, string > options=null) | |
| Constructs a GrantPermissionDirectoryRequest 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 | name [get, set] |
| Name of the user or role to which the permission will be granted. | |
| string | permission [get, set] |
| Permission to grant to the user or role. | |
| string | directory_name [get, set] |
| Name of the KiFS directory to which the permission grants access. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.grantPermissionDirectory.
Grants a KiFS directory-level permission to a user or role.
Definition at line 17 of file GrantPermissionDirectory.cs.
Constructor & Destructor Documentation
◆ GrantPermissionDirectoryRequest() [1/4]
| inline |
Constructs a GrantPermissionDirectoryRequest object with default parameters.
Definition at line 76 of file GrantPermissionDirectory.cs.
◆ GrantPermissionDirectoryRequest() [2/4]
| inline |
Constructs a GrantPermissionDirectoryRequest object with the specified parameters.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role. Supported values:
|
| directory_name | Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 108 of file GrantPermissionDirectory.cs.
◆ GrantPermissionDirectoryRequest() [3/4]
| inline |
Constructs a GrantPermissionDirectoryRequest object with default parameters.
Definition at line 76 of file GrantPermissionDirectory.cs.
◆ GrantPermissionDirectoryRequest() [4/4]
| inline |
Constructs a GrantPermissionDirectoryRequest object with the specified parameters.
| name | Name of the user or role to which the permission will be granted. Must be an existing user or role. |
| permission | Permission to grant to the user or role. Supported values:
|
| directory_name | Name of the KiFS directory to which the permission grants access. An empty directory name grants access to all KiFS directories. |
| options | Optional parameters. The default value is an empty Dictionary. |
Definition at line 108 of file GrantPermissionDirectory.cs.
Property Documentation
◆ 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 67 of file GrantPermissionDirectory.cs.
◆ 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 39 of file GrantPermissionDirectory.cs.
◆ options
| getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 72 of file GrantPermissionDirectory.cs.
◆ 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 61 of file GrantPermissionDirectory.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/GrantPermissionDirectory.cs
- Kinetica/Protocol/GrantPermissionDirectory.cs