org.azyva.dragom.jenkins

Interface JenkinsClient.Build

All Known Implementing Classes:

DefaultJenkinsClientImpl.DefaultBuildImpl

Enclosing interface:

JenkinsClient

public static interface JenkinsClient.Build

Represents a build.

Instances are created by JenkinsClient.build(java.lang.String, java.util.Map<java.lang.String, java.lang.String>).

Allows getting information about the build while it progresses to completion.

Method Summary

Modifier and Type	Method and Description
boolean	cancel() Cancels or aborts the build, depending on whether its JenkinsClient.BuildState is JenkinsClient.BuildState.QUEUED or JenkinsClient.BuildState.RUNNING.
String	getBuildName()
int	getBuildNumber()
JenkinsClient.BuildState	getBuildState() Updates and returns the BuildState.
String	getBuildUrl()
String	getFullConsole()
String	getJob()
String	getJobUrl()
String	getNextConsoleChunk()

Method Detail

getBuildState

JenkinsClient.BuildState getBuildState()

Updates and returns the BuildState.

Returns:

See description.

getJobUrl

String getJobUrl()

Returns:

Job URL.

getJob

String getJob()

Returns:

Job (full name).

getBuildUrl

String getBuildUrl()

Returns:

Build URL.

getBuildNumber

int getBuildNumber()

Returns:

Build number.

getBuildName

String getBuildName()

Returns:

Build (display) name.

cancel

boolean cancel()

Cancels or aborts the build, depending on whether its JenkinsClient.BuildState is JenkinsClient.BuildState.QUEUED or JenkinsClient.BuildState.RUNNING.

A build in any other BuildState cannot be cancelled and false is returned.

Returns:

Indicates if the build has been aborted or cancelled successfully. Generally this can be assumed to be true since if an error occurs, an exception is thrown.

getNextConsoleChunk

String getNextConsoleChunk()

Returns:

Returns the next chunk of console output or null if not JenkinsClient.BuildState.isOutOfQueue() or if no more data is available.

getFullConsole

String getFullConsole()

Returns:

Complete console output or null if not JenkinsClient.BuildState.isOutOfQueue().