Package io.jenkins.plugins.checks.steps
Class PublishChecksStep
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
-
- org.jenkinsci.plugins.workflow.steps.Step
-
- io.jenkins.plugins.checks.steps.PublishChecksStep
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
,Serializable
public class PublishChecksStep extends org.jenkinsci.plugins.workflow.steps.Step implements Serializable
Pipeline step to publish customized checks.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
PublishChecksStep.PublishChecksStepDescriptor
This step's descriptor which defines function name, display name, and context.static class
PublishChecksStep.StepChecksAction
A simple wrapper forChecksAction
to allow users add checks actions byPublishChecksStep
.static class
PublishChecksStep.StepChecksAnnotation
A simple wrapper forChecksAnnotation
to allow users add code annotations byPublishChecksStep
.-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description PublishChecksStep()
Constructor used for pipeline by Stapler.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description List<PublishChecksStep.StepChecksAction>
getActions()
List<PublishChecksStep.StepChecksAnnotation>
getAnnotations()
ChecksConclusion
getConclusion()
String
getDetailsURL()
String
getName()
ChecksStatus
getStatus()
String
getSummary()
String
getText()
String
getTitle()
void
setActions(List<PublishChecksStep.StepChecksAction> actions)
void
setAnnotations(List<PublishChecksStep.StepChecksAnnotation> annotations)
void
setConclusion(ChecksConclusion conclusion)
void
setDetailsURL(String detailsURL)
void
setName(String name)
void
setStatus(ChecksStatus status)
Change the status of the check.void
setSummary(String summary)
void
setText(String text)
void
setTitle(String title)
org.jenkinsci.plugins.workflow.steps.StepExecution
start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)
-
-
-
Method Detail
-
setName
@DataBoundSetter public void setName(String name)
-
setSummary
@DataBoundSetter public void setSummary(String summary)
-
setTitle
@DataBoundSetter public void setTitle(String title)
-
setText
@DataBoundSetter public void setText(String text)
-
setDetailsURL
@DataBoundSetter public void setDetailsURL(String detailsURL)
-
setStatus
@DataBoundSetter public void setStatus(ChecksStatus status)
Change the status of the check. When thestatus
isChecksStatus.QUEUED
orChecksStatus.IN_PROGRESS
, the conclusion will be reset toChecksConclusion.NONE
- Parameters:
status
- the status to be set
-
setConclusion
@DataBoundSetter public void setConclusion(ChecksConclusion conclusion)
-
setActions
@DataBoundSetter public void setActions(List<PublishChecksStep.StepChecksAction> actions)
-
setAnnotations
@DataBoundSetter public void setAnnotations(List<PublishChecksStep.StepChecksAnnotation> annotations)
-
getName
public String getName()
-
getSummary
public String getSummary()
-
getTitle
public String getTitle()
-
getText
public String getText()
-
getDetailsURL
public String getDetailsURL()
-
getStatus
public ChecksStatus getStatus()
-
getConclusion
public ChecksConclusion getConclusion()
-
getActions
public List<PublishChecksStep.StepChecksAction> getActions()
-
getAnnotations
public List<PublishChecksStep.StepChecksAnnotation> getAnnotations()
-
start
public org.jenkinsci.plugins.workflow.steps.StepExecution start(org.jenkinsci.plugins.workflow.steps.StepContext stepContext)
- Specified by:
start
in classorg.jenkinsci.plugins.workflow.steps.Step
-
-