org.jenkinsci.plugins.pipeline.githubstatusnotification

Class GitHubStatusNotificationStep

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.pipeline.githubstatusnotification.GitHubStatusNotificationStep

All Implemented Interfaces:

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

public final class GitHubStatusNotificationStep
extends org.jenkinsci.plugins.workflow.steps.AbstractStepImpl

A pipeline step that allows to send a commit status to GitHub. See GitHub's Statuses API

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GitHubStatusNotificationStep.DescriptorImpl
static class	GitHubStatusNotificationStep.Execution

Nested classes/interfaces inherited from interface hudson.ExtensionPoint

ExtensionPoint.LegacyInstancesAreScopedToHudson

Field Summary

Fields

Modifier and Type	Field and Description
static String	CREDENTIALS_ID_NOT_EXISTS
static String	CREDENTIALS_LOGIN_INVALID
static String	INVALID_COMMIT
static String	INVALID_REPO
static String	NULL_CREDENTIALS_ID

Constructor Summary

Constructors

Constructor and Description
GitHubStatusNotificationStep(org.kohsuke.github.GHCommitState status, String description)

Method Summary

Modifier and Type	Method and Description
String	getAccount()
String	getContext()
String	getCredentialsId()
String	getDescription()
String	getGitApiUrl()
String	getRepo()
String	getSha()
org.kohsuke.github.GHCommitState	getStatus()
String	getTargetUrl()
void	setAccount(String account)
void	setContext(String context)
void	setCredentialsId(String credentialsId)
void	setDescription(String description)
void	setGitApiUrl(String gitApiUrl)
void	setRepo(String repo)
void	setSha(String sha)
void	setStatus(org.kohsuke.github.GHCommitState status)
void	setTargetUrl(String targetUrl)

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

prepareInjector, start

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

Field Detail

CREDENTIALS_ID_NOT_EXISTS

public static final String CREDENTIALS_ID_NOT_EXISTS

See Also:

Constant Field Values

NULL_CREDENTIALS_ID

public static final String NULL_CREDENTIALS_ID

See Also:

Constant Field Values

CREDENTIALS_LOGIN_INVALID

public static final String CREDENTIALS_LOGIN_INVALID

See Also:

Constant Field Values

INVALID_REPO

public static final String INVALID_REPO

See Also:

Constant Field Values

INVALID_COMMIT

public static final String INVALID_COMMIT

See Also:

Constant Field Values

Constructor Detail

GitHubStatusNotificationStep

@DataBoundConstructor
public GitHubStatusNotificationStep(org.kohsuke.github.GHCommitState status,
                                                          String description)

Method Detail

setGitApiUrl

@DataBoundSetter
public void setGitApiUrl(String gitApiUrl)

setTargetUrl

@DataBoundSetter
public void setTargetUrl(String targetUrl)

setStatus

public void setStatus(org.kohsuke.github.GHCommitState status)

setDescription

public void setDescription(String description)

setContext

@DataBoundSetter
public void setContext(String context)

setRepo

@DataBoundSetter
public void setRepo(String repo)

setSha

@DataBoundSetter
public void setSha(String sha)

setAccount

@DataBoundSetter
public void setAccount(String account)

setCredentialsId

@DataBoundSetter
public void setCredentialsId(String credentialsId)

getStatus

public org.kohsuke.github.GHCommitState getStatus()

getDescription

public String getDescription()

getContext

public String getContext()

getRepo

public String getRepo()

getSha

public String getSha()

getGitApiUrl

public String getGitApiUrl()

getCredentialsId

public String getCredentialsId()

getAccount

public String getAccount()

getTargetUrl

public String getTargetUrl()