Package io.jenkins.blueocean.rest.model

Class BlueTrend

java.lang.Object

io.jenkins.blueocean.rest.model.Resource

io.jenkins.blueocean.rest.model.BlueTrend

All Implemented Interfaces:

BlueTable, Reachable

public abstract class BlueTrend
extends Resource
implements BlueTable

A category of tabular data, typically one that changes over time (e.g. across successive runs) To create a new "trend" 1. Implement BlueTrendFactory and return a new subclass of BlueTrend 2. Subclass BlueTable and BlueTableRow adding suitable properties to construct the data set.

Author:

cliffmeyers

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DISPLAY_NAME
static final String	ID

Fields inherited from interface io.jenkins.blueocean.rest.model.BlueTable

COLUMNS, ROWS

Constructor Summary

Constructors

Constructor	Description
BlueTrend()

Method Summary

Modifier and Type	Method	Description
abstract Map<String,String>	getColumns()
abstract String	getDisplayName()
abstract String	getId()	A unique identifier for the trend to be used in the REST API path, e.g.
abstract Container<BlueTableRow>	getRows()

Methods inherited from class io.jenkins.blueocean.rest.model.Resource

getLinks, getState

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jenkins.blueocean.rest.Reachable

getLink

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

DISPLAY_NAME

public static final String DISPLAY_NAME

See Also:

• Constant Field Values

Constructor Details

BlueTrend

public BlueTrend()

Method Details

getId

@Exported(name="id")
public abstract String getId()

A unique identifier for the trend to be used in the REST API path, e.g. my-pipeline/trends/${id} Note that an ID collision will result in only one trend being available.

Returns:

identifier

getDisplayName

@Exported(name="displayName")
public abstract String getDisplayName()

Returns:

name display in UI

getColumns

@Exported(name="columns",
          inline=true)
public abstract Map<String,String> getColumns()

Specified by:

getColumns in interface BlueTable

Returns:

map of columns' property names (keys) and descriptions (values). optional

getRows

@Navigable
public abstract Container<BlueTableRow> getRows()

Specified by:

getRows in interface BlueTable

Returns:

individual rows of data