@Internal public class JobConfigResource extends Object
JobConfigShortcutResource
.Modifier and Type | Field and Description |
---|---|
static RestJob |
ADD_JOB
Used for REST documentation generation.
|
static RestPageModel<RestJob> |
ALL_JOBS |
static RestJob |
JOB |
static RestWarnings |
JOB_WARNINGS
Used for REST documentation generation.
|
Constructor and Description |
---|
JobConfigResource(BambooPermissionManager bambooPermissionManager,
RestJobService restJobService,
JobService jobService,
InputParser inputParser,
com.atlassian.sal.api.message.I18nResolver i18nResolver,
PaginationService paginationService,
JobConversionFunction jobConversionFunction) |
Modifier and Type | Method and Description |
---|---|
javax.ws.rs.core.Response |
addJob(String planKeyString,
long stageId,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo,
RestJob restJob)
Adds a job to the given stage.
|
RestPageModel<RestJob> |
getAllJobsForStage(String planKeyString,
long stageId,
PageRequest pageRequest,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Return all jobs for the given stage.
|
RestWarnings |
getDeletionWarnings(String planKeyString,
long stageId,
String jobKeyString,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Retrieves the warnings in relation to deleting a job.
|
RestJob |
getJob(String planKeyString,
long stageId,
String jobKeyString,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Retrieves the details of a specific job of a stage of a build plan.
|
RestWarnings |
getMoveWarnings(String planKeyString,
long stageId,
String jobKeyString,
long targetStageId,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Retrieves the warnings in relation to moving a job.
|
javax.ws.rs.core.Response |
removeJob(String planKeyString,
long stageId,
String jobKeyString,
@Nullable ConfirmationToken confirmationToken,
javax.ws.rs.core.UriInfo uriInfo)
Deletes a specific job of a build plan.
|
RestJob |
updateJob(String planKeyString,
long stageId,
String jobKeyString,
@Nullable ConfirmationToken confirmationToken,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo,
RestJob restJob)
Updates a job partially, not overriding any field that it's not specified.
|
public static final RestJob ADD_JOB
public static final RestJob JOB
public static final RestPageModel<RestJob> ALL_JOBS
public static final RestWarnings JOB_WARNINGS
public JobConfigResource(BambooPermissionManager bambooPermissionManager, RestJobService restJobService, JobService jobService, InputParser inputParser, com.atlassian.sal.api.message.I18nResolver i18nResolver, PaginationService paginationService, JobConversionFunction jobConversionFunction)
public RestPageModel<RestJob> getAllJobsForStage(String planKeyString, long stageId, @Context PageRequest pageRequest, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
planKeyString
- plan to retrieve jobs forstageId
- stage to retrieve jobs forpageRequest
- represents the params that define which page the request is afterexpansion
- represents an expansion tree of additional information we want to retrieveRestJob
WebValidationException
public RestWarnings getDeletionWarnings(String planKeyString, long stageId, String jobKeyString, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
planKeyString
- the key for the planstageId
- the stage idjobKeyString
- the job key to retrieve warnings when movingexpansion
- represents an expansion tree of additional information we want to retrieveRestWarnings
containing warnings if job cannot be removedWebValidationException
public RestWarnings getMoveWarnings(String planKeyString, long stageId, String jobKeyString, long targetStageId, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
planKeyString
- the key for the planstageId
- the stage idjobKeyString
- the job key to retrieve warnings when movingtargetStageId
- stage id the job is going to be moved toexpansion
- represents an expansion tree of additional information we want to retrieveRestWarnings
containing warnings if job cannot be movedWebValidationException
public javax.ws.rs.core.Response addJob(String planKeyString, long stageId, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo, RestJob restJob) throws WebValidationException
planKeyString
- key for the planstageId
- stage to add the job toexpansion
- represents an expansion tree of additional information we want to retrieveuriInfo
- provides access to application and request URI informationrestJob
- representation of the job to be addedResponse
a response pointing to the location of the added jobWebValidationException
- if there's validation errors, which maps into a 400 Bad Requestpublic RestJob getJob(String planKeyString, long stageId, String jobKeyString, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
planKeyString
- the key of the planstageId
- unique identifier of the stage the job belongs tojobKeyString
- identifier of the job to retrieve details forexpansion
- represents an expansion tree of additional information we want to retrieveRestJob
WebValidationException
public RestJob updateJob(String planKeyString, long stageId, String jobKeyString, @Context @Nullable @Nullable ConfirmationToken confirmationToken, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo, RestJob restJob) throws WebValidationException
planKeyString
- the key of the plan the stage belongs tostageId
- the stage id of the stage the job belongs tojobKeyString
- identifier of the job to retrieve details forconfirmationToken
- token to validate that the job being updated has not been modified in the meantime,
in which case the operation would be rejected. To get this validation token see
getMoveWarnings(String, long, String, long, Expansion, UriInfo)
. This token in optional, if not
specified it won't be checked and the operation will be forced.expansion
- represents an expansion tree of additional information we want to retrieverestJob
- representation of the job to updateRestJob
WebValidationException
- if there's validation errors, which maps into a 400 Bad Requestpublic javax.ws.rs.core.Response removeJob(String planKeyString, long stageId, String jobKeyString, @Context @Nullable @Nullable ConfirmationToken confirmationToken, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
planKeyString
- the key for the planstageId
- unique identifier of the stage the job belongs tojobKeyString
- identifier of the job to deleteconfirmationToken
- token to validate that the job being deleted has not been modified in the meantime,
in which case the operation would be rejected. To get this validation token see
getDeletionWarnings(String, long, String, Expansion, UriInfo)
. This token in optional, if not
specified it won't be checked and the operation will be forced.uriInfo
- provides access to application and request URI informationResponse
an empty responseWebValidationException
Copyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.