|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Build
This interface describes a Bamboo Build.
Field Summary | |
---|---|
static int |
MAX_NUMBER_LOG_ENTRIES
|
static int |
MAX_PREVIOUS_BUILD_FOR_AVE
|
static java.lang.String |
STATUS_CURRENTLY_BUILDING
|
static java.lang.String |
STATUS_FAIL
|
static java.lang.String |
STATUS_NO_BUILDS
|
static java.lang.String |
STATUS_SUCCESS
|
Method Summary | |
---|---|
void |
addBuildResultSummary(BuildResultsSummary buildResultsSummary)
Add the given build results summary to the build. |
long |
getAverageBuildDuration()
Returns an average duration of the recent builds |
BuildDefinition |
getBuildDefinition()
Returns the BuildDefinition that backs this buildd |
BuildDefinitionForBuild |
getBuildDefinitionXml()
|
java.lang.String |
getBuildKey()
Thie returns the build portion of the build key |
BuildLogger |
getBuildLogger()
Returns the helper object to deal with logging |
java.lang.String |
getBuildName()
|
java.util.List |
getBuildResultSummaries()
Obtains the builds total collection of BuildResultsSummary objects
(oldest first), one for each build. |
java.util.Set<Build> |
getChildBuilds()
Get the dependant child builds for the current build |
java.lang.String |
getCurrentStatus()
Retuns a string key as to what the status is. |
int |
getFirstBuildNumber()
What the number of the first build we have? It may not be 1 as some may have been removed! |
BuildResultsSummary |
getFirstBuildSummary()
|
java.lang.String |
getKey()
Obtain the build's unique key (uppercase alphanumeric). |
java.util.List |
getLabellings()
|
int |
getLastBuildNumber()
What was the number of the lastest build (may be being built) |
java.lang.String |
getLastVcsRevisionKey()
The string value representing the last build triggered. |
ExtendedBuildResultsSummary |
getLatestBuildSummary()
Get the summary from the latest build |
java.lang.String |
getName()
Returns the full name for the build in the form of "projet name - build name" e.g. |
int |
getNextBuildNumber()
The next build number represents the number of the next build result that's to be executed |
BuildResults |
getNextBuildResults(int buildNumber)
|
NotificationSet |
getNotificationSet()
|
java.util.Set<Build> |
getParentBuilds()
Get the parent builds for the current build |
BuildResults |
getPreviousBuildResults(int buildNumber)
Gets the first BuildResultsImpl before the passed number |
Project |
getProject()
Returns the parent Project |
RequirementSet |
getRequirementSet()
|
java.io.File |
getSourceCodeDirectory()
Returns a file representing the source directory from the Repository |
boolean |
hasBuildResults()
Has the build got any build results to display? |
boolean |
isBusy()
Does something have a lock on the build |
boolean |
isExecuting()
Is the build currenlty being executed? |
boolean |
isInBuildQueue()
Is the build currenlty being built? |
boolean |
isMarkedForDeletion()
Whether or not the build has been marked for deletion |
boolean |
isSuspendedFromBuilding()
Checks if the build has been |
void |
markForDeletion()
Marks the build to be deleted. |
void |
setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
|
void |
setBuildKey(java.lang.String buildKey)
Define the build's unique key (uppercase alphanumeric) |
void |
setBuildName(java.lang.String buildName)
|
void |
setChildBuilds(java.util.Set<Build> childBuilds)
Set the dependant child builds for the current builds |
void |
setFirstBuildNumber(int firstBuildNumber)
|
void |
setKey(java.lang.String fullKey)
|
void |
setLabellings(java.util.List labellings)
|
void |
setLastBuildNumber(int lastBuildNumber)
|
void |
setLastVcsRevisionKey(java.lang.String lastVcsRevisionKey)
|
void |
setNextBuildNumber(int nextBuildNumber)
|
void |
setNotificationSet(NotificationSet notificationSet)
|
void |
setParentBuilds(java.util.Set<Build> parentBuilds)
Set the parent builds for the current build |
void |
setProject(Project project)
|
void |
setRequirementSet(RequirementSet requirementSet)
|
void |
setSuspendedFromBuilding(boolean suspendFromBuilding)
Sets the build to suspend temporarily |
void |
unMarkForDeletion()
Build will no longer be marked for deletion |
ErrorCollection |
validateBuild()
Validates the build's builder and source code locations |
Methods inherited from interface com.atlassian.bamboo.core.BambooObject |
---|
getId, setId |
Field Detail |
---|
static final int MAX_NUMBER_LOG_ENTRIES
static final int MAX_PREVIOUS_BUILD_FOR_AVE
static final java.lang.String STATUS_FAIL
static final java.lang.String STATUS_SUCCESS
static final java.lang.String STATUS_CURRENTLY_BUILDING
static final java.lang.String STATUS_NO_BUILDS
Method Detail |
---|
java.lang.String getKey()
void setKey(java.lang.String fullKey)
java.lang.String getBuildKey()
void setBuildKey(java.lang.String buildKey)
buildKey
- The value of the keyjava.lang.String getName()
java.lang.String getBuildName()
void setBuildName(java.lang.String buildName)
ErrorCollection validateBuild()
ErrorCollection
with relevent error messagesjava.lang.String getCurrentStatus()
long getAverageBuildDuration()
java.io.File getSourceCodeDirectory() throws RepositoryException
Repository
RepositoryException
boolean isInBuildQueue()
boolean isExecuting()
void markForDeletion()
void unMarkForDeletion()
boolean isMarkedForDeletion()
void setSuspendedFromBuilding(boolean suspendFromBuilding)
suspendFromBuilding
- boolean isSuspendedFromBuilding()
java.util.List getBuildResultSummaries()
BuildResultsSummary
objects
(oldest first), one for each build.
@Nullable ExtendedBuildResultsSummary getLatestBuildSummary()
int getLastBuildNumber()
int getFirstBuildNumber()
BuildResultsSummary getFirstBuildSummary()
boolean hasBuildResults()
void addBuildResultSummary(BuildResultsSummary buildResultsSummary)
buildResultsSummary
- The build summaryBuildResults getPreviousBuildResults(int buildNumber)
BuildResultsImpl
before the passed number
buildNumber
-
BuildResultsImpl
. null if no build results can be found before that numberBuildResults getNextBuildResults(int buildNumber)
BuildDefinition getBuildDefinition()
BuildDefinition
that backs this buildd
BuildDefinition
object. Never null.Project getProject()
Project
Project
. Never nullvoid setProject(Project project)
int getNextBuildNumber()
void setNextBuildNumber(int nextBuildNumber)
void setLastBuildNumber(int lastBuildNumber)
void setFirstBuildNumber(int firstBuildNumber)
BuildDefinitionForBuild getBuildDefinitionXml()
void setBuildDefinitionXml(BuildDefinitionForBuild buildDefinitionXml)
java.util.List getLabellings()
void setLabellings(java.util.List labellings)
NotificationSet getNotificationSet()
void setNotificationSet(NotificationSet notificationSet)
java.util.Set<Build> getParentBuilds()
void setParentBuilds(java.util.Set<Build> parentBuilds)
parentBuilds
- java.util.Set<Build> getChildBuilds()
void setChildBuilds(java.util.Set<Build> childBuilds)
childBuilds
- BuildLogger getBuildLogger()
BuildLogger
. @NotNull@Nullable java.lang.String getLastVcsRevisionKey()
void setLastVcsRevisionKey(java.lang.String lastVcsRevisionKey)
@NotNull RequirementSet getRequirementSet()
void setRequirementSet(RequirementSet requirementSet)
boolean isBusy()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |