kinetica.ExportQueryMetricsRequest Class Reference

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 options. More...

Public Member Functions
	ExportQueryMetricsRequest ()
	Constructs an ExportQueryMetricsRequest object with default parameters. More...
	ExportQueryMetricsRequest (IDictionary< string, string > options=null)
	Constructs an ExportQueryMetricsRequest object with the specified parameters. More...
	ExportQueryMetricsRequest ()
	Constructs an ExportQueryMetricsRequest object with default parameters. More...
	ExportQueryMetricsRequest (IDictionary< string, string > options=null)
	Constructs an ExportQueryMetricsRequest 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...
	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...
Properties inherited from Avro.Specific.ISpecificRecord
Schema	Schema [get]

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...
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.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 112 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

options

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: JSON: Generic json output JSON_TRACE_EVENT: Chromium/Perfetto trace event format 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 161 of file ExportQueryMetrics.cs.

ExportQueryMetricsRequest() [3/4]

kinetica.ExportQueryMetricsRequest.ExportQueryMetricsRequest ( )

inline

Constructs an ExportQueryMetricsRequest object with default parameters.

Definition at line 112 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

options

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: JSON: Generic json output JSON_TRACE_EVENT: Chromium/Perfetto trace event format 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 161 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:
  • JSON: Generic json output
  • JSON_TRACE_EVENT: Chromium/Perfetto trace event format
  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 108 of file ExportQueryMetrics.cs.

---

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

• _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/ExportQueryMetrics.cs