Package io.jenkins.plugins.dorametrics.ui

Class DoraApiAction

java.lang.Object

io.jenkins.plugins.dorametrics.ui.DoraApiAction

All Implemented Interfaces:

ExtensionPoint, Action, ModelObject, RootAction

@Extension
public class DoraApiAction
extends Object
implements RootAction

REST API at /dora-api/ for DORA metrics data.

Nested Class Summary

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
DoraApiAction()

Method Summary

Modifier and Type	Method	Description
org.kohsuke.stapler.HttpResponse	doExport(String daysParam, String format, String fromParam, String toParam, String tzParam)
org.kohsuke.stapler.HttpResponse	doImportHistory()	Starts a build history import.
org.kohsuke.stapler.HttpResponse	doImportStatus()	Counters for the running or most recent import.
org.kohsuke.stapler.HttpResponse	doOverview(String daysParam, String fromParam, String toParam, String tzParam)
org.kohsuke.stapler.HttpResponse	doPipelines(String daysParam, String limitParam, String fromParam, String toParam, String tzParam)
org.kohsuke.stapler.HttpResponse	doStages(String daysParam, String limitParam, String fromParam, String toParam, String tzParam)	Stage rankings for the period, as the dashboard lists them.
org.kohsuke.stapler.HttpResponse	doTrends(String daysParam, String jobName, String fromParam, String toParam, String tzParam)	One point for every day of the period, in the viewer's time zone when tz is given.
String	getDisplayName()
String	getIconFileName()
String	getUrlName()

Methods inherited from class java.lang.Object

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

Methods inherited from interface hudson.model.RootAction

getBadge, isPrimaryAction

Constructor Details

DoraApiAction

public DoraApiAction()

Method Details

getIconFileName

public String getIconFileName()

Specified by:

getIconFileName in interface Action

getDisplayName

public String getDisplayName()

Specified by:

getDisplayName in interface Action

Specified by:

getDisplayName in interface ModelObject

getUrlName

public String getUrlName()

Specified by:

getUrlName in interface Action

doImportHistory

@POST
public org.kohsuke.stapler.HttpResponse doImportHistory()

Starts a build history import. Administer only, and POST only, because it writes. Returns immediately: the import runs on Jenkins' own executor, and the caller polls doImportStatus() for the counters.

doImportStatus

@GET
public org.kohsuke.stapler.HttpResponse doImportStatus()

Counters for the running or most recent import. Administer only, and deliberately counters only: it exposes no job names or build data.

doOverview

@GET
public org.kohsuke.stapler.HttpResponse doOverview(@QueryParameter("days")
 String daysParam,
 @QueryParameter("from")
 String fromParam,
 @QueryParameter("to")
 String toParam,
 @QueryParameter("tz")
 String tzParam)

doPipelines

@GET
public org.kohsuke.stapler.HttpResponse doPipelines(@QueryParameter("days")
 String daysParam,
 @QueryParameter("limit")
 String limitParam,
 @QueryParameter("from")
 String fromParam,
 @QueryParameter("to")
 String toParam,
 @QueryParameter("tz")
 String tzParam)

doStages

@GET
public org.kohsuke.stapler.HttpResponse doStages(@QueryParameter("days")
 String daysParam,
 @QueryParameter("limit")
 String limitParam,
 @QueryParameter("from")
 String fromParam,
 @QueryParameter("to")
 String toParam,
 @QueryParameter("tz")
 String tzParam)

Stage rankings for the period, as the dashboard lists them.

doTrends

@GET
public org.kohsuke.stapler.HttpResponse doTrends(@QueryParameter("days")
 String daysParam,
 @QueryParameter("job")
 String jobName,
 @QueryParameter("from")
 String fromParam,
 @QueryParameter("to")
 String toParam,
 @QueryParameter("tz")
 String tzParam)

One point for every day of the period, in the viewer's time zone when tz is given. Besides the build counts and durations, each day carries the four DORA metrics for that day, filtered as the dashboard cards are, so a chart can show what they show. A metric with nothing to measure that day is null.

doExport

@GET
public org.kohsuke.stapler.HttpResponse doExport(@QueryParameter("days")
 String daysParam,
 @QueryParameter("format")
 String format,
 @QueryParameter("from")
 String fromParam,
 @QueryParameter("to")
 String toParam,
 @QueryParameter("tz")
 String tzParam)