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

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

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

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 DeleteDirectoryRequest ()
 Constructs a DeleteDirectoryRequest object with default parameters. More...
 
 DeleteDirectoryRequest (string directory_name, IDictionary< string, string > options=null)
 Constructs a DeleteDirectoryRequest 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 directory_name [get, set]
 Name of the directory in KiFS to be deleted. 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.deleteDirectory(string,IDictionary{string, string}).


Deletes a directory from KiFS.

Definition at line 20 of file DeleteDirectory.cs.

Constructor & Destructor Documentation

kinetica.DeleteDirectoryRequest.DeleteDirectoryRequest ( )
inline

Constructs a DeleteDirectoryRequest object with default parameters.

Definition at line 162 of file DeleteDirectory.cs.

kinetica.DeleteDirectoryRequest.DeleteDirectoryRequest ( string  directory_name,
IDictionary< string, string >  options = null 
)
inline

Constructs a DeleteDirectoryRequest object with the specified parameters.

Parameters
directory_nameName of the directory in KiFS to be deleted. The directory must contain no files, unless recursive is true
optionsOptional 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 214 of file DeleteDirectory.cs.

Property Documentation

string kinetica.DeleteDirectoryRequest.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 112 of file DeleteDirectory.cs.

IDictionary<string, string> kinetica.DeleteDirectoryRequest.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 157 of file DeleteDirectory.cs.


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