Skip to main content

A set of parameters for Kinetica.exportQueryMetrics. More…

Inheritance diagram for kinetica.ExportQueryMetricsRequest:
Collaboration diagram for kinetica.ExportQueryMetricsRequest:

Classes

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

Public Member Functions

 ExportQueryMetricsRequest ()
 Constructs an ExportQueryMetricsRequest object with default parameters.
 
 ExportQueryMetricsRequest (IDictionary< string, string > options=null)
 Constructs an ExportQueryMetricsRequest object with the specified parameters.
 
 ExportQueryMetricsRequest ()
 Constructs an ExportQueryMetricsRequest object with default parameters.
 
 ExportQueryMetricsRequest (IDictionary< string, string > options=null)
 Constructs an ExportQueryMetricsRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

Properties

IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

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.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

Detailed Description

A set of parameters for Kinetica.exportQueryMetrics.

Export query metrics to a given destination. Returns query metrics.

Definition at line 16 of file ExportQueryMetrics.cs.

Constructor & Destructor Documentation

◆ ExportQueryMetricsRequest() [1/4]

kinetica.ExportQueryMetricsRequest.ExportQueryMetricsRequest ()
inline

Constructs an ExportQueryMetricsRequest object with default parameters.

Definition at line 126 of file ExportQueryMetrics.cs.

◆ ExportQueryMetricsRequest() [2/4]

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

Constructs an ExportQueryMetricsRequest object with the specified parameters.

Parameters
optionsOptional parameters.
  • EXPRESSION: Filter for multi query export.
  • FILEPATH: Path to export target specified as a filename or existing directory.
  • FORMAT: Specifies which format to export the metrics. Supported values:The default value is JSON.
  • JOB_ID: Export query metrics for the currently running job.
  • LIMIT: Record limit per file for multi query export.
The default value is an empty Dictionary.

Definition at line 187 of file ExportQueryMetrics.cs.

◆ ExportQueryMetricsRequest() [3/4]

kinetica.ExportQueryMetricsRequest.ExportQueryMetricsRequest ()
inline

Constructs an ExportQueryMetricsRequest object with default parameters.

Definition at line 126 of file ExportQueryMetrics.cs.

◆ ExportQueryMetricsRequest() [4/4]

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

Constructs an ExportQueryMetricsRequest object with the specified parameters.

Parameters
optionsOptional parameters.
  • EXPRESSION: Filter for multi query export.
  • FILEPATH: Path to export target specified as a filename or existing directory.
  • FORMAT: Specifies which format to export the metrics. Supported values:The default value is JSON.
  • JOB_ID: Export query metrics for the currently running job.
  • LIMIT: Record limit per file for multi query export.
The default value is an empty Dictionary.

Definition at line 187 of file ExportQueryMetrics.cs.

Property Documentation

◆ options

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

Optional parameters.

  • EXPRESSION: Filter for multi query export.
  • FILEPATH: Path to export target specified as a filename or existing directory.
  • FORMAT: Specifies which format to export the metrics. Supported values:The default value is JSON.
  • JOB_ID: Export query metrics for the currently running job.
  • LIMIT: Record limit per file for multi query export.

The default value is an empty Dictionary.

Definition at line 122 of file ExportQueryMetrics.cs.


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