Package io.jenkins.plugins.interactiveinput.output

Class MetricReport

java.lang.Object

io.jenkins.plugins.interactiveinput.output.MetricReport

All Implemented Interfaces:

Serializable

public class MetricReport
extends Object
implements Serializable

A named group of Metrics published by one interactiveOutput call (e.g. "Cost report" or "Carbon footprint"). A build may hold several reports; they are stored in the build's InteractiveOutputBuildAction and therefore persisted in build.xml via XStream.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CHART_BAR	Cross-build trend as a grouped bar chart.
static final String	CHART_LINE	Cross-build trend as a line chart (default).
static final String	CHART_PIE	The latest build's numeric metrics as a pie chart.
static final String	CHART_TIMESERIES	The latest build's metrics as a time series, when each metric's LABEL is a date/timestamp (e.g.

Constructor Summary

Constructors

Constructor	Description
MetricReport(String name, List<Metric> metrics, long createdTs)
MetricReport(String name, List<Metric> metrics, long createdTs, String chartType)

Method Summary

Modifier and Type	Method	Description
String	getChartType()
Date	getCreatedDate()
long	getCreatedTs()
List<Metric>	getMetrics()
String	getName()

Methods inherited from class java.lang.Object

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

Field Details

CHART_LINE

public static final String CHART_LINE

Cross-build trend as a line chart (default).

See Also:

• Constant Field Values

CHART_BAR

public static final String CHART_BAR

Cross-build trend as a grouped bar chart.

See Also:

• Constant Field Values

CHART_PIE

public static final String CHART_PIE

The latest build's numeric metrics as a pie chart.

See Also:

• Constant Field Values

CHART_TIMESERIES

public static final String CHART_TIMESERIES

The latest build's metrics as a time series, when each metric's LABEL is a date/timestamp (e.g. 2026-07-01). Points are emitted sorted by date and can be re-bucketed (day/month/year) client-side. Labels that do not parse as a date are skipped.

See Also:

• Constant Field Values

Constructor Details

MetricReport

public MetricReport(@NonNull
 String name,
 @NonNull
 List<Metric> metrics,
 long createdTs)

MetricReport

public MetricReport(@NonNull
 String name,
 @NonNull
 List<Metric> metrics,
 long createdTs,
 @CheckForNull
 String chartType)

Method Details

getName

@NonNull
public String getName()

getChartType

@NonNull
public String getChartType()

Returns:

the report's chart type, defaulting legacy/blank/unknown values to CHART_LINE.

getMetrics

@NonNull
public List<Metric> getMetrics()

getCreatedTs

public long getCreatedTs()

getCreatedDate

@NonNull
public Date getCreatedDate()