com.offbytwo.jenkins.model

Class JobWithDetails

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.Job

com.offbytwo.jenkins.model.JobWithDetails

public class JobWithDetails
extends Job

Field Summary

Fields inherited from class com.offbytwo.jenkins.model.BaseModel

client

Constructor Summary

Constructors

Constructor and Description
JobWithDetails()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<Build>	getAllBuilds() This method will give you back all builds which exists independent of the number.
List<Build>	getAllBuilds(Range range) {M,N}: From the M-th element (inclusive) to the N-th element (exclusive). {M,}: From the M-th element (inclusive) to the end. {,N}: From the first element (inclusive) to the N-th element (exclusive).
Build	getBuildByNumber(int buildNumber)
List<Build>	getBuilds() This method will give you back the builds of a particular job. Note: Jenkins limits the number of results to a maximum of 100 builds which you will get back..
String	getDescription()
String	getDisplayName()
List<Job>	getDownstreamProjects()
Build	getFirstBuild()
Build	getLastBuild()
Build	getLastCompletedBuild()
Build	getLastFailedBuild()
Build	getLastStableBuild()
Build	getLastSuccessfulBuild()
Build	getLastUnstableBuild()
Build	getLastUnsuccessfulBuild()
int	getNextBuildNumber()
QueueItem	getQueueItem()
List<Job>	getUpstreamProjects()
boolean	hasDescription()
int	hashCode()
boolean	isBuildable()
boolean	isInQueue()

Methods inherited from class com.offbytwo.jenkins.model.Job

build, build, build, build, details, getFileFromWorkspace, getName, getUrl

Methods inherited from class com.offbytwo.jenkins.model.BaseModel

getClient, setClient

Methods inherited from class java.lang.Object

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

Constructor Detail

JobWithDetails

public JobWithDetails()

Method Detail

getDescription

public String getDescription()

hasDescription

public boolean hasDescription()

getDisplayName

public String getDisplayName()

isBuildable

public boolean isBuildable()

isInQueue

public boolean isInQueue()

getBuilds

public List<Build> getBuilds()

This method will give you back the builds of a particular job.
Note: Jenkins limits the number of results to a maximum of 100 builds which you will get back.. In case you have more than 100 build you won't get back all builds via this method. In such cases you need to use getAllBuilds().

Returns:

the list of Build. In case of no builds have been executed yet return Collections.emptyList().

getAllBuilds

public List<Build> getAllBuilds()
                         throws IOException

This method will give you back all builds which exists independent of the number. You should be aware that this can be much in some cases if you have more than 100 builds which is by default limited by Jenkins getBuilds(). This method limits it to particular information which can be later used to get supplemental information about a particular build Build.details() to reduce the amount of data which needed to be transfered.

Returns:

the list of Build. In case of no builds have been executed yet return Collections.emptyList().

Throws:

IOException - In case of failure.

See Also:

Jenkins Issue

getAllBuilds

public List<Build> getAllBuilds(Range range)
                         throws IOException

• {M,N}: From the M-th element (inclusive) to the N-th element (exclusive).
• {M,}: From the M-th element (inclusive) to the end.
• {,N}: From the first element (inclusive) to the N-th element (exclusive). The same as {0,N}.
• {N}: Just retrieve the N-th element. The same as {N,N+1}.

Note: At the moment there seemed to be no option to get the number of existing builds for a job. The only option is to get all builds via getAllBuilds().

Parameters:

range - Range

Returns:

the list of Build. In case of no builds have been executed yet return Collections.emptyList().

Throws:

IOException - in case of an error.

getFirstBuild

public Build getFirstBuild()

Returns:

the first build which has been executed or Build.BUILD_HAS_NEVER_RAN is this has never been executed.

getLastBuild

public Build getLastBuild()

getLastCompletedBuild

public Build getLastCompletedBuild()

getLastFailedBuild

public Build getLastFailedBuild()

getLastStableBuild

public Build getLastStableBuild()

getLastSuccessfulBuild

public Build getLastSuccessfulBuild()

getLastUnstableBuild

public Build getLastUnstableBuild()

getLastUnsuccessfulBuild

public Build getLastUnsuccessfulBuild()

getNextBuildNumber

public int getNextBuildNumber()

getDownstreamProjects

public List<Job> getDownstreamProjects()

Returns:

the list of downstream projects. If no downstream projects exist just return an empty list Collections.emptyList().

getUpstreamProjects

public List<Job> getUpstreamProjects()

Returns:

the list of upstream projects. If no upstream projects exist just return an empty list Collections.emptyList().

getQueueItem

public QueueItem getQueueItem()

getBuildByNumber

public Build getBuildByNumber(int buildNumber)

hashCode

public int hashCode()

Overrides:

hashCode in class Job

equals

public boolean equals(Object obj)

Overrides:

equals in class Job