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

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

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

Public Member Functions

 ShowFilesRequest ()
 Constructs a ShowFilesRequest object with default parameters. More...
 
 ShowFilesRequest (IList< string > paths, IDictionary< string, string > options=null)
 Constructs a ShowFilesRequest 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 > paths [get, set]
 File paths to show. More...
 
IDictionary< string, string > options = new List<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.showFiles(IList{string},IDictionary{string, string}).


Shows information about files in KiFS. Can be used for individual files, or to show all files in a given directory.

Definition at line 21 of file ShowFiles.cs.

Constructor & Destructor Documentation

kinetica.ShowFilesRequest.ShowFilesRequest ( )
inline

Constructs a ShowFilesRequest object with default parameters.

Definition at line 40 of file ShowFiles.cs.

kinetica.ShowFilesRequest.ShowFilesRequest ( IList< string >  paths,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowFilesRequest object with the specified parameters.

Parameters
pathsFile paths to show. Each path can be a KiFS directory name, or a full path to a KiFS file. 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.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 54 of file ShowFiles.cs.

Property Documentation

IDictionary<string, string> kinetica.ShowFilesRequest.options = new List<string>()
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 35 of file ShowFiles.cs.

IList<string> kinetica.ShowFilesRequest.paths
getset

File paths to show.

Each path can be a KiFS directory name, or a full path to a KiFS file. 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 31 of file ShowFiles.cs.


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