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

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

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

Public Member Functions

 ShowDirectoriesRequest ()
 Constructs a ShowDirectoriesRequest object with default parameters. More...
 
 ShowDirectoriesRequest (string directory_name=null, IDictionary< string, string > options=null)
 Constructs a ShowDirectoriesRequest 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]
 The KiFS directory name to show. 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.showDirectories(string,IDictionary{string, string}).


Shows information about directories in KiFS. Can be used to show a single directory, or all directories.

Definition at line 21 of file ShowDirectories.cs.

Constructor & Destructor Documentation

kinetica.ShowDirectoriesRequest.ShowDirectoriesRequest ( )
inline

Constructs a ShowDirectoriesRequest object with default parameters.

Definition at line 35 of file ShowDirectories.cs.

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

Constructs a ShowDirectoriesRequest object with the specified parameters.

Parameters
directory_nameThe KiFS directory name to show. If empty, shows all directories. The default value is ''.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 45 of file ShowDirectories.cs.

Property Documentation

string kinetica.ShowDirectoriesRequest.directory_name
getset

The KiFS directory name to show.

If empty, shows all directories. The default value is ''.

Definition at line 26 of file ShowDirectories.cs.

IDictionary<string, string> kinetica.ShowDirectoriesRequest.options = ""
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 30 of file ShowDirectories.cs.


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