|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.bamboo.plugins.rest.resource.QueueResource
@Singleton public class QueueResource
Lists all the builds waiting in the build queue, adds or removes a build from the build queue. May be used also to resume build on manual stage or rerun failed jobs.
Constructor Summary | |
---|---|
QueueResource(PlanManager planManager,
BambooUserManager bambooUserManager,
BuildQueueManager buildQueueManager,
PlanExecutionManager planExecutionManager,
ResultsSummaryManager resultsSummaryManager)
|
Method Summary | |
---|---|
RestQueuedBuild |
continueBuild(java.lang.String projectKey,
java.lang.String buildKey,
java.lang.Integer buildNumber,
java.lang.String stageName,
boolean executeAllStages,
javax.ws.rs.core.UriInfo uriInfo,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
Continue partially done build. |
RestQueuedBuilds |
getBuildQueue(javax.ws.rs.core.UriInfo uriInfo)
Provide list of build scheduled for execution and waiting in build queue. |
RestQueuedBuild |
startBuild(java.lang.String projectKey,
java.lang.String buildKey,
java.lang.String stageName,
boolean executeAllStages,
javax.ws.rs.core.UriInfo uriInfo,
com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext,
java.lang.String fakeParam,
javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> formParams)
Fire build execution for specified plan. |
javax.ws.rs.core.Response |
stopBuild(java.lang.String projectKey,
java.lang.String buildKey,
int buildNumber)
Stop build execution, however only if build has not been started yet - so if is waiting in the build queue. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public QueueResource(PlanManager planManager, BambooUserManager bambooUserManager, BuildQueueManager buildQueueManager, PlanExecutionManager planExecutionManager, ResultsSummaryManager resultsSummaryManager)
Method Detail |
---|
public RestQueuedBuilds getBuildQueue(@Context javax.ws.rs.core.UriInfo uriInfo)
uriInfo
-
public RestQueuedBuild startBuild(java.lang.String projectKey, java.lang.String buildKey, java.lang.String stageName, boolean executeAllStages, @Context javax.ws.rs.core.UriInfo uriInfo, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext, java.lang.String fakeParam, javax.ws.rs.core.MultivaluedMap<java.lang.String,java.lang.String> formParams)
projectKey
- project keybuildKey
- plan key (only top level plan key, can not be job key)stageName
- name of the stage that should be executed even if defined as manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stageexecuteAllStages
- enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail.fakeParam
- unused form parameteruriInfo
- authenticationContext
- formParams
- payload of additional variables passed to build start (application/x-www-form-urlencoded). Variables may be passed as HTTP POST form or optionally as URL query parameter=value collection. Variables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable
public RestQueuedBuild continueBuild(java.lang.String projectKey, java.lang.String buildKey, java.lang.Integer buildNumber, java.lang.String stageName, boolean executeAllStages, @Context javax.ws.rs.core.UriInfo uriInfo, @Context com.atlassian.plugins.rest.common.security.AuthenticationContext authenticationContext)
projectKey
- project keybuildKey
- plan key (only top level plan key, can not be job key)buildNumber
- build number to resume/rerunstageName
- name of the stage that should be executed even if manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stageexecuteAllStages
- enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail.uriInfo
- authenticationContext
-
public javax.ws.rs.core.Response stopBuild(java.lang.String projectKey, java.lang.String buildKey, int buildNumber)
projectKey
- project keybuildKey
- plan key - IMPORTANT: as build queue contains only jobs not top level plans, plan key here MUST be a job key as opposite to other methods in this resource.buildNumber
- build number
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |