A set of parameters for Kinetica.deleteDirectory. More…
Inheritance diagram for kinetica.DeleteDirectoryRequest:
[legend]
Collaboration diagram for kinetica.DeleteDirectoryRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter DeleteDirectoryRequest.options. More… | |
Public Member Functions | |
| DeleteDirectoryRequest () | |
| Constructs a DeleteDirectoryRequest object with default parameters. | |
| DeleteDirectoryRequest (string directory_name, IDictionary< string, string > options=null) | |
| Constructs a DeleteDirectoryRequest object with the specified parameters. | |
| DeleteDirectoryRequest () | |
| Constructs a DeleteDirectoryRequest object with default parameters. | |
| DeleteDirectoryRequest (string directory_name, IDictionary< string, string > options=null) | |
| Constructs a DeleteDirectoryRequest 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 | directory_name [get, set] |
| Name of the directory in KiFS to be deleted. | |
| 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.deleteDirectory.
Deletes a directory from KiFS.
Definition at line 16 of file DeleteDirectory.cs.
Constructor & Destructor Documentation
◆ DeleteDirectoryRequest() [1/4]
| inline |
Constructs a DeleteDirectoryRequest object with default parameters.
Definition at line 138 of file DeleteDirectory.cs.
◆ DeleteDirectoryRequest() [2/4]
| inline |
Constructs a DeleteDirectoryRequest object with the specified parameters.
Parameters
| directory_name | Name of the directory in KiFS to be deleted. The directory must contain no files, unless RECURSIVE is TRUE. |
| options | Optional parameters.
|
Definition at line 200 of file DeleteDirectory.cs.
◆ DeleteDirectoryRequest() [3/4]
| inline |
Constructs a DeleteDirectoryRequest object with default parameters.
Definition at line 138 of file DeleteDirectory.cs.
◆ DeleteDirectoryRequest() [4/4]
| inline |
Constructs a DeleteDirectoryRequest object with the specified parameters.
Parameters
| directory_name | Name of the directory in KiFS to be deleted. The directory must contain no files, unless RECURSIVE is TRUE. |
| options | Optional parameters.
|
Definition at line 200 of file DeleteDirectory.cs.
Property Documentation
◆ directory_name
| getset |
Name of the directory in KiFS to be deleted.
The directory must contain no files, unless RECURSIVE is TRUE.
Definition at line 79 of file DeleteDirectory.cs.
◆ options
| getset |
Optional parameters.
- RECURSIVE: If TRUE, will delete directory and all files residing in it. If false, directory must be empty for deletion. Supported values:The default value is FALSE.
- NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if specified directory does not exist. Supported values:The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 134 of file DeleteDirectory.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/DeleteDirectory.cs
- Kinetica/Protocol/DeleteDirectory.cs