Kinetica   C#   API  Version 7.2.3.0
kinetica.ShowSystemPropertiesRequest Class Reference

A set of parameters for Kinetica.showSystemProperties. More...

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

Classes

struct  Options
 A set of string constants for the parameter options. More...
 

Public Member Functions

 ShowSystemPropertiesRequest ()
 Constructs a ShowSystemPropertiesRequest object with default parameters. More...
 
 ShowSystemPropertiesRequest (IDictionary< string, string > options=null)
 Constructs a ShowSystemPropertiesRequest 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

IDictionary< string, string > options = new Dictionary<string, 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.showSystemProperties.

Returns server configuration and version related information to the caller. The admin tool uses it to present server related information to the user.

Definition at line 17 of file ShowSystemProperties.cs.

Constructor & Destructor Documentation

◆ ShowSystemPropertiesRequest() [1/2]

kinetica.ShowSystemPropertiesRequest.ShowSystemPropertiesRequest ( )
inline

Constructs a ShowSystemPropertiesRequest object with default parameters.

Definition at line 46 of file ShowSystemProperties.cs.

◆ ShowSystemPropertiesRequest() [2/2]

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

Constructs a ShowSystemPropertiesRequest object with the specified parameters.

Parameters
optionsOptional parameters.
  • PROPERTIES: A list of comma separated names of properties requested. If not specified, all properties will be returned.
The default value is an empty Dictionary.

Definition at line 62 of file ShowSystemProperties.cs.

Property Documentation

◆ options

IDictionary<string, string> kinetica.ShowSystemPropertiesRequest.options = new Dictionary<string, string>()
getset

Optional parameters.

  • PROPERTIES: A list of comma separated names of properties requested. If not specified, all properties will be returned.

The default value is an empty Dictionary.

Definition at line 42 of file ShowSystemProperties.cs.


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