org.apache.spark.sql.connector.metric

Class CustomSumMetric

Object

org.apache.spark.sql.connector.metric.CustomSumMetric

All Implemented Interfaces:

CustomMetric

@Evolving
public abstract class CustomSumMetric
extends Object
implements CustomMetric

Built-in `CustomMetric` that sums up metric values. Note that please extend this class and override `name` and `description` to create your custom metric for real usage.

Since:

3.2.0

Field Summary

Fields inherited from interface org.apache.spark.sql.connector.metric.CustomMetric

initialValue

Constructor Summary

Constructors

Constructor and Description
CustomSumMetric()

Method Summary

Modifier and Type	Method and Description
String	aggregateTaskMetrics(long[] taskMetrics) Given an array of task metric values, returns aggregated final metric value.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.spark.sql.connector.metric.CustomMetric

description, name

Constructor Detail

CustomSumMetric

public CustomSumMetric()

Method Detail

aggregateTaskMetrics

public String aggregateTaskMetrics(long[] taskMetrics)

Description copied from interface: CustomMetric

Given an array of task metric values, returns aggregated final metric value.

Specified by:

aggregateTaskMetrics in interface CustomMetric