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

A set of parameters for /show/types. More...

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

Public Member Functions

 ShowTypesRequest ()
 Constructs a ShowTypesRequest object with default parameters. More...
 
 ShowTypesRequest (string type_id, string label, IDictionary< string, string > options=null)
 Constructs a ShowTypesRequest 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 in response to a call to /create/type. More...
 
string label [get, set]
 Option string that was supplied by user in a call to /create/type. 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 /show/types.


Retrieves information for the specified data type. Given a type ID, the database returns the data type schema, the label, and the semantic type along with the type ID. If the user provides any combination of label and semantic type, then the database returns the pertinent information for all data types that match the input criteria.

Definition at line 21 of file ShowTypes.cs.

Constructor & Destructor Documentation

kinetica.ShowTypesRequest.ShowTypesRequest ( )
inline

Constructs a ShowTypesRequest object with default parameters.

Definition at line 38 of file ShowTypes.cs.

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

Constructs a ShowTypesRequest object with the specified parameters.

Parameters
type_idType Id returned in response to a call to /create/type.
labelOption string that was supplied by user in a call to /create/type.
optionsOptional parameters.

Definition at line 49 of file ShowTypes.cs.

Property Documentation

string kinetica.ShowTypesRequest.label
getset

Option string that was supplied by user in a call to /create/type.

Definition at line 30 of file ShowTypes.cs.

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

Optional parameters.

Definition at line 33 of file ShowTypes.cs.

string kinetica.ShowTypesRequest.type_id
getset

Type Id returned in response to a call to /create/type.

Definition at line 26 of file ShowTypes.cs.


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