Kinetica C# API  Version 6.2.0.1
kinetica.ShowTablesByTypeRequest Class Reference

A set of parameters for Kinetica.showTablesByType(string,string,IDictionary<string, string>). More...

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

Public Member Functions

 ShowTablesByTypeRequest ()
 Constructs a ShowTablesByTypeRequest object with default parameters. More...
 
 ShowTablesByTypeRequest (string type_id, string label, IDictionary< string, string > options=null)
 Constructs a ShowTablesByTypeRequest 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 type_id [get, set]
 Type id returned by a call to /create/type. More...
 
string label [get, set]
 Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label. 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.showTablesByType(string,string,IDictionary<string, string>).


Gets names of the tables whose type matches the given criteria. Each table has a particular type. This type comprises the schema and properties of the table and sometimes a type label. This function allows a look up of the existing tables based on full or partial type information. The operation is synchronous.

Definition at line 23 of file ShowTablesByType.cs.

Constructor & Destructor Documentation

◆ ShowTablesByTypeRequest() [1/2]

kinetica.ShowTablesByTypeRequest.ShowTablesByTypeRequest ( )
inline

Constructs a ShowTablesByTypeRequest object with default parameters.

Definition at line 41 of file ShowTablesByType.cs.

◆ ShowTablesByTypeRequest() [2/2]

kinetica.ShowTablesByTypeRequest.ShowTablesByTypeRequest ( string  type_id,
string  label,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowTablesByTypeRequest object with the specified parameters.

Parameters
type_idType id returned by a call to /create/type.
labelOptional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 54 of file ShowTablesByType.cs.

Property Documentation

◆ label

string kinetica.ShowTablesByTypeRequest.label
getset

Optional user supplied label which can be used instead of the type_id to retrieve all tables with the given label.

Definition at line 32 of file ShowTablesByType.cs.

◆ options

IDictionary<string, string> kinetica.ShowTablesByTypeRequest.options
getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 36 of file ShowTablesByType.cs.

◆ type_id

string kinetica.ShowTablesByTypeRequest.type_id
getset

Type id returned by a call to /create/type.

Definition at line 27 of file ShowTablesByType.cs.


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