Package io.jenkins.plugins.gerritchecksapi

Enum Class StageDepth

java.lang.Object

java.lang.Enum<StageDepth>

io.jenkins.plugins.gerritchecksapi.StageDepth

All Implemented Interfaces:

Serializable, Comparable<StageDepth>, Constable

public enum StageDepth
extends Enum<StageDepth>

How many of the stages of a Pipeline build are reported. A pipeline with tens of nested stages is difficult to read in Gerrit, so the nested ones can be left out.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Report every stage, however deeply nested.
INHERIT	Leave the setting to the enclosing folder and finally to the global configuration.
MAX_DEPTH	Report stages up to StageReporting.getMaxDepth() levels deep.
TOP_LEVEL	Report only the stages that are not nested inside another stage.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Label of the option in the configuration forms.
boolean	isSet()
static StageDepth	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StageDepth[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INHERIT

public static final StageDepth INHERIT

Leave the setting to the enclosing folder and finally to the global configuration.

ALL

public static final StageDepth ALL

Report every stage, however deeply nested.

TOP_LEVEL

public static final StageDepth TOP_LEVEL

Report only the stages that are not nested inside another stage.

MAX_DEPTH

public static final StageDepth MAX_DEPTH

Report stages up to StageReporting.getMaxDepth() levels deep.

Method Details

values

public static StageDepth[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static StageDepth valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

isSet

public boolean isSet()

getDisplayName

public String getDisplayName()

Label of the option in the configuration forms.