public class BuildWithDetails extends Build
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 |
Constructor and Description |
---|
BuildWithDetails() |
BuildWithDetails(BuildWithDetails details) |
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. |
details, getNumber, getQueueId, getTestReport, getTestResult, getUrl, setNumber, setQueueId, setUrl, Stop
public static final String TEXT_SIZE_HEADER
public static final String MORE_DATA_HEADER
public static final BuildWithDetails BUILD_HAS_NEVER_RUN
Build.BUILD_HAS_NEVER_RUN
public static final BuildWithDetails BUILD_HAS_BEEN_CANCELLED
Build.BUILD_HAS_BEEN_CANCELLED
public BuildWithDetails()
public BuildWithDetails(BuildWithDetails details)
public boolean isBuilding()
public List<BuildCause> getCauses()
public void updateDisplayNameAndDescription(String displayName, String description, boolean crumbFlag) throws IOException
displayName
and the description
of a
build.displayName
- The new displayName which should be set.description
- The description which should be set.crumbFlag
- true
or false
.IOException
- in case of errors.public void updateDisplayNameAndDescription(String displayName, String description) throws IOException
displayName
and the description
of a
build.displayName
- The new displayName which should be set.description
- The description which should be set.IOException
- in case of errors.public void updateDisplayName(String displayName, boolean crumbFlag) throws IOException
displayName
of a build.displayName
- The new displayName which should be set.crumbFlag
- true
or false
.IOException
- in case of errors.public void updateDisplayName(String displayName) throws IOException
displayName
of a build.displayName
- The new displayName which should be set.IOException
- in case of errors.public void updateDescription(String description, boolean crumbFlag) throws IOException
description
of a build.description
- The description which should be set.crumbFlag
- true
or false
.IOException
- in case of errors.public void updateDescription(String description) throws IOException
description
of a build.description
- The description which should be set.IOException
- in case of errors.public String getDescription()
public long getDuration()
public long getEstimatedDuration()
public String getFullDisplayName()
public String getDisplayName()
public String getId()
public long getTimestamp()
public BuildResult getResult()
public String getBuiltOn()
public List getActions()
public String getConsoleOutputText() throws IOException
CR+LF
.IOException
- in case of a failure.method for obtaining logs for running build
public String getConsoleOutputHtml() throws IOException
IOException
- in case of an error.method for obtaining logs for running build
public void streamConsoleOutput(BuildConsoleStreamListener listener, int poolingInterval, int poolingTimeout) throws InterruptedException, IOException
listener
- interface used to asynchronously obtain logspoolingInterval
- interval (seconds) used to pool jenkins for logspoolingTimeout
- pooling timeout (seconds) used to break pooling in case build stuckInterruptedException
IOException
public ConsoleLog getConsoleOutputText(int bufferOffset) throws IOException
bufferOffset
- offset in console loCR+LF
.IOException
- in case of a failure.public BuildChangeSet getChangeSet()
public void setChangeSet(BuildChangeSet changeSet)
public List<BuildChangeSetAuthor> getCulprits()
public void setCulprits(List<BuildChangeSetAuthor> culprits)
public void setResult(BuildResult result)
public InputStream downloadArtifact(Artifact a) throws IOException, URISyntaxException
IOException
URISyntaxException
Copyright © 2017 JBoss by Red Hat. All rights reserved.