A set of parameters for Kinetica.deleteFiles. More...
Inheritance diagram for kinetica.DeleteFilesRequest:
Collaboration diagram for kinetica.DeleteFilesRequest:
Classes | |
| struct | Options |
| A set of string constants for the parameter options. More... | |
Public Member Functions | |
| DeleteFilesRequest () | |
| Constructs a DeleteFilesRequest object with default parameters. More... | |
| DeleteFilesRequest (IList< string > file_names, IDictionary< string, string > options=null) | |
| Constructs a DeleteFilesRequest 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 | |
| IList< string > | file_names = new List<string>() [get, set] |
| An array of names of files to be deleted. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [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.deleteFiles.
Deletes one or more files from KiFS.
Definition at line 16 of file DeleteFiles.cs.
Constructor & Destructor Documentation
◆ DeleteFilesRequest() [1/2]
|
inline |
Constructs a DeleteFilesRequest object with default parameters.
Definition at line 76 of file DeleteFiles.cs.
◆ DeleteFilesRequest() [2/2]
|
inline |
Constructs a DeleteFilesRequest object with the specified parameters.
- Parameters
-
file_names An array of names of files to be deleted. File paths may contain wildcard characters after the KiFS directory delimeter. Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character. options Optional parameters. - NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if a specified file does not exist. Supported values: The default value is FALSE.
Definition at line 109 of file DeleteFiles.cs.
Property Documentation
◆ file_names
|
getset |
An array of names of files to be deleted.
File paths may contain wildcard characters after the KiFS directory delimeter.
Accepted wildcard characters are asterisk (*) to represent any string of zero or more characters, and question mark (?) to indicate a single character.
Definition at line 48 of file DeleteFiles.cs.
◆ options
|
getset |
Optional parameters.
- NO_ERROR_IF_NOT_EXISTS: If TRUE, no error is returned if a specified file does not exist. Supported values: The default value is FALSE.
The default value is an empty Dictionary.
Definition at line 72 of file DeleteFiles.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/DeleteFiles.cs
