Package com.gpudb.protocol

Class ExportQueryMetricsRequest

java.lang.Object

com.gpudb.protocol.ExportQueryMetricsRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class ExportQueryMetricsRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.exportQueryMetrics.

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ExportQueryMetricsRequest.Options	A set of string constants for the ExportQueryMetricsRequest parameter options.

Constructor Summary

Constructors

Constructor	Description
ExportQueryMetricsRequest()	Constructs an ExportQueryMetricsRequest object with default parameters.
ExportQueryMetricsRequest(Map<String,String> options)	Constructs an ExportQueryMetricsRequest object with the specified parameters.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Object	get(int index)	This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
Map<String,String>	getOptions()	Optional parameters.
org.apache.avro.Schema	getSchema()	This method supports the Avro framework and is not intended to be called directly by the user.
int	hashCode()
void	put(int index, Object value)	This method supports the Avro framework and is not intended to be called directly by the user.
ExportQueryMetricsRequest	setOptions(Map<String,String> options)	Optional parameters.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ExportQueryMetricsRequest

public ExportQueryMetricsRequest()

Constructs an ExportQueryMetricsRequest object with default parameters.

ExportQueryMetricsRequest

public ExportQueryMetricsRequest(Map<String,String> options)

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

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

The schema for the class.

getOptions

public Map<String,String> getOptions()

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

Returns:

The current value of options.

setOptions

public ExportQueryMetricsRequest setOptions(Map<String,String> 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 Map.

Parameters:

options - The new value for options.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

The schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object