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

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

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

Public Member Functions

 ShowDatasinkRequest ()
 Constructs a ShowDatasinkRequest object with default parameters. More...
 
 ShowDatasinkRequest (string name, IDictionary< string, string > options=null)
 Constructs a ShowDatasinkRequest 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 name [get, set]
 Name of the data sink for which to retrieve information. 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.showDatasink(string,IDictionary{string, string}).


Shows information about a specified data sink or all data sinks.

Definition at line 20 of file ShowDatasink.cs.

Constructor & Destructor Documentation

kinetica.ShowDatasinkRequest.ShowDatasinkRequest ( )
inline

Constructs a ShowDatasinkRequest object with default parameters.

Definition at line 36 of file ShowDatasink.cs.

kinetica.ShowDatasinkRequest.ShowDatasinkRequest ( string  name,
IDictionary< string, string >  options = null 
)
inline

Constructs a ShowDatasinkRequest object with the specified parameters.

Parameters
nameName of the data sink for which to retrieve information. The name must refer to a currently existing data sink. If '*' is specified, information about all data sinks will be returned.
optionsOptional parameters. The default value is an empty Dictionary.

Definition at line 48 of file ShowDatasink.cs.

Property Documentation

string kinetica.ShowDatasinkRequest.name
getset

Name of the data sink for which to retrieve information.

The name must refer to a currently existing data sink. If '*' is specified, information about all data sinks will be returned.

Definition at line 27 of file ShowDatasink.cs.

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

Optional parameters.

The default value is an empty Dictionary.

Definition at line 31 of file ShowDatasink.cs.


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