Class SetCommitStatusStep
- java.lang.Object
-
- hudson.model.AbstractDescribableImpl<org.jenkinsci.plugins.workflow.steps.Step>
-
- org.jenkinsci.plugins.workflow.steps.Step
-
- org.jenkinsci.plugins.workflow.steps.AbstractStepImpl
-
- org.jenkinsci.plugins.github.pullrequest.pipeline.SetCommitStatusStep
-
- All Implemented Interfaces:
ExtensionPoint
,Describable<org.jenkinsci.plugins.workflow.steps.Step>
,Serializable
public class SetCommitStatusStep extends org.jenkinsci.plugins.workflow.steps.AbstractStepImpl implements Serializable
Representation of the configuration for the commit status set step. An instance of this class is made available to the SetCommitStatusExecution object to instruct it on what to do.- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SetCommitStatusStep.DescriptorImpl
-
Nested classes/interfaces inherited from interface hudson.ExtensionPoint
ExtensionPoint.LegacyInstancesAreScopedToHudson
-
-
Constructor Summary
Constructors Constructor Description SetCommitStatusStep()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
getContext()
The desired context for the status.String
getMessage()
The message associated with the status providing some detail for it.org.kohsuke.github.GHCommitState
getState()
The desired state of the status.void
setContext(String context)
void
setMessage(String message)
void
setState(org.kohsuke.github.GHCommitState state)
-
-
-
Method Detail
-
getContext
public String getContext()
The desired context for the status. The context identifies a status value on the commit. For example, with two status values, one might have a context of "compile" and another might have one with "tests" to indicate which phase of the build/validation the status applies to.
-
setContext
@DataBoundSetter public void setContext(String context)
-
getState
public org.kohsuke.github.GHCommitState getState()
The desired state of the status.
-
setState
@DataBoundSetter public void setState(org.kohsuke.github.GHCommitState state)
-
getMessage
public String getMessage()
The message associated with the status providing some detail for it.
-
setMessage
@DataBoundSetter public void setMessage(String message)
-
-