com.offbytwo.jenkins.model

Class BuildWithDetails

java.lang.Object

com.offbytwo.jenkins.model.BaseModel

com.offbytwo.jenkins.model.Build

com.offbytwo.jenkins.model.BuildWithDetails

public class BuildWithDetails
extends Build

This class represents build information with details about what has been done like duration start and of course the build result.

Field Summary

Fields

Modifier and Type	Field and Description
static BuildWithDetails	BUILD_HAS_BEEN_CANCELLED This will be returned by the API in cases where the build has been cancelled.
static BuildWithDetails	BUILD_HAS_NEVER_RUN This will be returned by the API in cases where the build has never run.
static String	MORE_DATA_HEADER
static String	TEXT_SIZE_HEADER

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

client

Constructor Summary

Constructors

Constructor and Description
BuildWithDetails()
BuildWithDetails(BuildWithDetails details)

Method Summary

Modifier and Type	Method and Description
InputStream	downloadArtifact(Artifact a)
boolean	equals(Object obj)
List	getActions()
List<Artifact>	getArtifacts()
String	getBuiltOn()
List<BuildCause>	getCauses()
BuildChangeSet	getChangeSet()
String	getConsoleOutputHtml() The full console output with HTML.
String	getConsoleOutputText()
ConsoleLog	getConsoleOutputText(int bufferOffset) Get build console output log as text.
List<BuildChangeSetAuthor>	getCulprits()
String	getDescription()
String	getDisplayName()
long	getDuration()
long	getEstimatedDuration()
String	getFullDisplayName()
String	getId()
Map<String,String>	getParameters()
BuildResult	getResult()
long	getTimestamp()
int	hashCode()
boolean	isBuilding()
void	setChangeSet(BuildChangeSet changeSet)
void	setCulprits(List<BuildChangeSetAuthor> culprits)
void	setResult(BuildResult result)
void	streamConsoleOutput(BuildConsoleStreamListener listener, int poolingInterval, int poolingTimeout) Stream build console output log as text using BuildConsoleStreamListener Method can be used to asynchronously obtain logs for running build.
void	updateDescription(String description) Update the description of a build.
void	updateDescription(String description, boolean crumbFlag) Update the description of a build.
void	updateDisplayName(String displayName) Update displayName of a build.
void	updateDisplayName(String displayName, boolean crumbFlag) Update displayName of a build.
void	updateDisplayNameAndDescription(String displayName, String description) Update displayName and the description of a build.
void	updateDisplayNameAndDescription(String displayName, String description, boolean crumbFlag) Update displayName and the description of a build.

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

details, getNumber, getQueueId, getTestReport, getTestResult, getUrl, setNumber, setQueueId, setUrl, Stop

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

get_class, getClient, setClient

Methods inherited from class java.lang.Object

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

Field Detail

TEXT_SIZE_HEADER

public static final String TEXT_SIZE_HEADER

See Also:

Constant Field Values

MORE_DATA_HEADER

public static final String MORE_DATA_HEADER

See Also:

Constant Field Values

BUILD_HAS_NEVER_RUN

public static final BuildWithDetails BUILD_HAS_NEVER_RUN

This will be returned by the API in cases where the build has never run. For example Build.BUILD_HAS_NEVER_RUN

BUILD_HAS_BEEN_CANCELLED

public static final BuildWithDetails BUILD_HAS_BEEN_CANCELLED

This will be returned by the API in cases where the build has been cancelled. For example Build.BUILD_HAS_BEEN_CANCELLED

Constructor Detail

BuildWithDetails

public BuildWithDetails()

BuildWithDetails

public BuildWithDetails(BuildWithDetails details)

Method Detail

getArtifacts

public List<Artifact> getArtifacts()

isBuilding

public boolean isBuilding()

getCauses

public List<BuildCause> getCauses()

updateDisplayNameAndDescription

public void updateDisplayNameAndDescription(String displayName,
                                            String description,
                                            boolean crumbFlag)
                                     throws IOException

Update displayName and the description of a build.

Parameters:

displayName - The new displayName which should be set.

description - The description which should be set.

crumbFlag - true or false.

Throws:

IOException - in case of errors.

updateDisplayNameAndDescription

public void updateDisplayNameAndDescription(String displayName,
                                            String description)
                                     throws IOException

Update displayName and the description of a build.

Parameters:

displayName - The new displayName which should be set.

description - The description which should be set.

Throws:

IOException - in case of errors.

updateDisplayName

public void updateDisplayName(String displayName,
                              boolean crumbFlag)
                       throws IOException

Update displayName of a build.

Parameters:

displayName - The new displayName which should be set.

crumbFlag - true or false.

Throws:

IOException - in case of errors.

updateDisplayName

public void updateDisplayName(String displayName)
                       throws IOException

Update displayName of a build.

Parameters:

displayName - The new displayName which should be set.

Throws:

IOException - in case of errors.

updateDescription

public void updateDescription(String description,
                              boolean crumbFlag)
                       throws IOException

Update the description of a build.

Parameters:

description - The description which should be set.

crumbFlag - true or false.

Throws:

IOException - in case of errors.

updateDescription

public void updateDescription(String description)
                       throws IOException

Update the description of a build.

Parameters:

description - The description which should be set.

Throws:

IOException - in case of errors.

getDescription

public String getDescription()

getDuration

public long getDuration()

getEstimatedDuration

public long getEstimatedDuration()

getFullDisplayName

public String getFullDisplayName()

getDisplayName

public String getDisplayName()

getId

public String getId()

getTimestamp

public long getTimestamp()

getResult

public BuildResult getResult()

getBuiltOn

public String getBuiltOn()

getActions

public List getActions()

getParameters

public Map<String,String> getParameters()

getConsoleOutputText

public String getConsoleOutputText()
                            throws IOException

Returns:

The full console output of the build. The line separation is done by CR+LF.

Throws:

IOException - in case of a failure.

See Also:

method for obtaining logs for running build

getConsoleOutputHtml

public String getConsoleOutputHtml()
                            throws IOException

The full console output with HTML.

Returns:

The console output as HTML.

Throws:

IOException - in case of an error.

See Also:

method for obtaining logs for running build

streamConsoleOutput

public void streamConsoleOutput(BuildConsoleStreamListener listener,
                                int poolingInterval,
                                int poolingTimeout)
                         throws InterruptedException,
                                IOException

Stream build console output log as text using BuildConsoleStreamListener Method can be used to asynchronously obtain logs for running build.

Parameters:

listener - interface used to asynchronously obtain logs

poolingInterval - interval (seconds) used to pool jenkins for logs

poolingTimeout - pooling timeout (seconds) used to break pooling in case build stuck

Throws:

InterruptedException

IOException

getConsoleOutputText

public ConsoleLog getConsoleOutputText(int bufferOffset)
                                throws IOException

Get build console output log as text. Use this method to periodically obtain logs from jenkins and skip chunks that were already received

Parameters:

bufferOffset - offset in console lo

Returns:

ConsoleLog object containing console output of the build. The line separation is done by CR+LF.

Throws:

IOException - in case of a failure.

getChangeSet

public BuildChangeSet getChangeSet()

setChangeSet

public void setChangeSet(BuildChangeSet changeSet)

getCulprits

public List<BuildChangeSetAuthor> getCulprits()

setCulprits

public void setCulprits(List<BuildChangeSetAuthor> culprits)

setResult

public void setResult(BuildResult result)

downloadArtifact

public InputStream downloadArtifact(Artifact a)
                             throws IOException,
                                    URISyntaxException

Throws:

IOException

URISyntaxException

equals

public boolean equals(Object obj)

Overrides:

equals in class Build

hashCode

public int hashCode()

Overrides:

hashCode in class Build