Package io.jenkins.plugins.checks.steps

Class WithChecksStep

java.lang.Object

hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>

org.jenkinsci.plugins.workflow.steps.Step

io.jenkins.plugins.checks.steps.WithChecksStep

All Implemented Interfaces:

ExtensionPoint, Describable<org.jenkinsci.plugins.workflow.steps.Step>, Serializable

public class WithChecksStep
extends org.jenkinsci.plugins.workflow.steps.Step
implements Serializable

Pipeline step that injects a ChecksInfo into the closure.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WithChecksStep.WithChecksStepDescriptor	This step's descriptor which defines the function name ("withChecks") and required context.

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Constructor Summary

Constructors

Constructor	Description
WithChecksStep(String name)	Creates the step with a name to inject.

Method Summary

Modifier and Type	Method	Description
String	getName()
boolean	isIncludeStage()
void	setIncludeStage(boolean includeStage)
org.jenkinsci.plugins.workflow.steps.StepExecution	start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)

Methods inherited from class org.jenkinsci.plugins.workflow.steps.Step

getDescriptor

Methods inherited from class java.lang.Object

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

Constructor Details

WithChecksStep

@DataBoundConstructor
public WithChecksStep(String name)

Creates the step with a name to inject.

Parameters:

name - name to inject

Method Details

getName

public String getName()

isIncludeStage

public boolean isIncludeStage()

setIncludeStage

@DataBoundSetter
public void setIncludeStage(boolean includeStage)

start

public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)

Specified by:

start in class org.jenkinsci.plugins.workflow.steps.Step