Package org.jenkinsci.plugins.github_branch_source

Class GitHubNotificationRequest

java.lang.Object

org.jenkinsci.plugins.github_branch_source.GitHubNotificationRequest

public class GitHubNotificationRequest
extends Object

Details of a GitHub status notification to be sent.

One GitHubNotificationRequest represents one notification. A strategy supplies a list of these to request one or more notifications. Notifications are differentiated by their Context label. If two notification requests with the same Context label are provided, one will override the other.

Since:

2.3.2

See Also:

GitHub API for details of the purpose of each notification field.

Method Summary

Modifier and Type	Method	Description
static GitHubNotificationRequest	build(String context, String url, String message, org.kohsuke.github.GHCommitState state, boolean ignoreError)
boolean	equals(Object o)
String	getContext()	Returns the context label to be used for a notification
String	getMessage()	Returns the message for a notification
org.kohsuke.github.GHCommitState	getState()	Returns the commit state of a notification
String	getUrl()	Returns the URL to be supplied with a notification
int	hashCode()
boolean	isIgnoreError()	Returns whether the notification processor should ignore errors when interacting with GitHub
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

build

public static GitHubNotificationRequest build(String context,
                                              String url,
                                              String message,
                                              org.kohsuke.github.GHCommitState state,
                                              boolean ignoreError)

getContext

public String getContext()

Returns the context label to be used for a notification

Returns:

context

Since:

2.3.2

getUrl

public String getUrl()

Returns the URL to be supplied with a notification

Returns:

url

Since:

2.3.2

getMessage

public String getMessage()

Returns the message for a notification

Returns:

message

Since:

2.3.2

getState

public org.kohsuke.github.GHCommitState getState()

Returns the commit state of a notification

Returns:

state

Since:

2.3.2

isIgnoreError

public boolean isIgnoreError()

Returns whether the notification processor should ignore errors when interacting with GitHub

Returns:

ignoreError

Since:

2.3.2

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object