Package io.jenkins.plugins.gerritchecksapi

Class StageReporting

java.lang.Object

io.jenkins.plugins.gerritchecksapi.StageReporting

All Implemented Interfaces:

Serializable

public class StageReporting
extends Object
implements Serializable

The settings controlling which stages of a Pipeline build are reported to Gerrit.

A value that is left as INHERIT is taken from the enclosing folder, then from the global configuration and finally from defaults(), which reports every stage.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
StageReporting()
StageReporting(Inheritable reportStages, Inheritable reportStagesWhileBuilding, StageForm stageForm, StageDepth stageDepth, int maxDepth, Inheritable skipDeclarativeStages)

Method Summary

Modifier and Type	Method	Description
static StageReporting	defaults()	The settings used where nothing is configured at all.
int	getMaxDepth()
Inheritable	getReportStages()
Inheritable	getReportStagesWhileBuilding()
Inheritable	getSkipDeclarativeStages()
StageDepth	getStageDepth()
StageForm	getStageForm()
boolean	isReportStagesEnabled()	Whether the stages of a build are reported at all.
boolean	isReportStagesWhileBuildingEnabled()	Whether the stages of a build that is still building are reported.
boolean	isSkipDeclarativeStagesEnabled()	Whether the stages that Jenkins itself adds to a declarative pipeline are left out.
int	maxReportedDepth()	The deepest nesting of stages that is reported, where 1 is a stage that is not nested inside another stage.
void	overlay(StageReporting other)	Copies the values that the other settings set on top of these.
boolean	reportsStagesAsCheckRuns()	Whether the stages are reported as check runs of their own rather than as results of the run of their build.
void	setMaxDepth(int maxDepth)
void	setReportStages(Inheritable reportStages)
void	setReportStagesWhileBuilding(Inheritable reportStagesWhileBuilding)
void	setSkipDeclarativeStages(Inheritable skipDeclarativeStages)
void	setStageDepth(StageDepth stageDepth)
void	setStageForm(StageForm stageForm)

Methods inherited from class java.lang.Object

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

Constructor Details

StageReporting

public StageReporting()

StageReporting

public StageReporting(Inheritable reportStages,
 Inheritable reportStagesWhileBuilding,
 StageForm stageForm,
 StageDepth stageDepth,
 int maxDepth,
 Inheritable skipDeclarativeStages)

Method Details

defaults

public static StageReporting defaults()

The settings used where nothing is configured at all.

overlay

public void overlay(StageReporting other)

Copies the values that the other settings set on top of these. Settings that are left to be inherited keep the value they had, so that earlier settings act as the fallback.

isReportStagesEnabled

public boolean isReportStagesEnabled()

Whether the stages of a build are reported at all.

isReportStagesWhileBuildingEnabled

public boolean isReportStagesWhileBuildingEnabled()

Whether the stages of a build that is still building are reported. Left out, the stages of a build are reported once it has finished, so that the results of a run do not change while it runs.

reportsStagesAsCheckRuns

public boolean reportsStagesAsCheckRuns()

Whether the stages are reported as check runs of their own rather than as results of the run of their build.

maxReportedDepth

public int maxReportedDepth()

The deepest nesting of stages that is reported, where 1 is a stage that is not nested inside another stage. A value of 0 means that every stage is reported, however deeply nested.

isSkipDeclarativeStagesEnabled

public boolean isSkipDeclarativeStagesEnabled()

Whether the stages that Jenkins itself adds to a declarative pipeline are left out.

getReportStages

public Inheritable getReportStages()

setReportStages

public void setReportStages(Inheritable reportStages)

getReportStagesWhileBuilding

public Inheritable getReportStagesWhileBuilding()

setReportStagesWhileBuilding

public void setReportStagesWhileBuilding(Inheritable reportStagesWhileBuilding)

getStageForm

public StageForm getStageForm()

setStageForm

public void setStageForm(StageForm stageForm)

getStageDepth

public StageDepth getStageDepth()

setStageDepth

public void setStageDepth(StageDepth stageDepth)

getMaxDepth

public int getMaxDepth()

setMaxDepth

public void setMaxDepth(int maxDepth)

getSkipDeclarativeStages

public Inheritable getSkipDeclarativeStages()

setSkipDeclarativeStages

public void setSkipDeclarativeStages(Inheritable skipDeclarativeStages)