public interface RestJobService
Modifier and Type | Method and Description |
---|---|
@NotNull RestJob |
addJob(@NotNull PlanKey planKey,
long stageId,
@Nullable RestJob restJob,
@NotNull Expansion expansion,
@NotNull javax.ws.rs.core.UriInfo uriInfo)
Create a new job
|
void |
deleteJob(@NotNull PlanKey jobKey,
@NotNull Optional<ConfirmationToken> confirmationToken,
@NotNull javax.ws.rs.core.UriInfo uriInfo)
Remove a job.
|
@NotNull Token |
getDeleteConfirmationToken(@NotNull PlanKey jobKey,
@NotNull javax.ws.rs.core.UriInfo uriInfo)
Generate the delete confirmation token to be used for the given job key.
|
@NotNull RestWarnings |
getJobDeletionWarnings(@NotNull PlanKey jobKey,
@NotNull Expansion expansion,
@NotNull javax.ws.rs.core.UriInfo uriInfo)
Get warnings related to job deletion.
|
@NotNull RestWarnings |
getJobMoveWarnings(@NotNull PlanKey jobKey,
long targetStageId,
@NotNull Expansion expansion,
@NotNull javax.ws.rs.core.UriInfo uriInfo)
Get warnings related to job move.
|
@NotNull RestJob |
updateJob(@NotNull PlanKey jobKey,
@Nullable RestJob restJob,
@NotNull Optional<ConfirmationToken> confirmationToken,
@NotNull Expansion expansion,
@NotNull javax.ws.rs.core.UriInfo uriInfo)
Updates the details of a specific job.
|
@NotNull @NotNull RestJob addJob(@NotNull @NotNull PlanKey planKey, long stageId, @Nullable @Nullable RestJob restJob, @NotNull @NotNull Expansion expansion, @NotNull @NotNull javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
planKey
- of plan job is instageId
- of stage job is inrestJob
- Rest Jobexpansion
- the expansion.uriInfo
- URI info from the requestWebValidationException
@NotNull @NotNull RestJob updateJob(@NotNull @NotNull PlanKey jobKey, @Nullable @Nullable RestJob restJob, @NotNull @NotNull Optional<ConfirmationToken> confirmationToken, @NotNull @NotNull Expansion expansion, @NotNull @NotNull javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKey
- of job.restJob
- job details.confirmationToken
- The token to match before performing the updateexpansion
- the expansion.uriInfo
- URI info from the requestWebValidationException
void deleteJob(@NotNull @NotNull PlanKey jobKey, @NotNull @NotNull Optional<ConfirmationToken> confirmationToken, @NotNull @NotNull javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKey
- of jobconfirmationToken
- The token to match before performing the deleteuriInfo
- URI info from the requestConflictException
- if there is a token validation errorWebValidationException
@NotNull @NotNull RestWarnings getJobDeletionWarnings(@NotNull @NotNull PlanKey jobKey, @NotNull @NotNull Expansion expansion, @NotNull @NotNull javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKey
- of jobexpansion
- the expansion.uriInfo
- URI info from the requestWebValidationException
@NotNull @NotNull Token getDeleteConfirmationToken(@NotNull @NotNull PlanKey jobKey, @NotNull @NotNull javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKey
- job key to generate the token for.uriInfo
- URI info from the requestWebValidationException
- if the job key is invalid.@NotNull @NotNull RestWarnings getJobMoveWarnings(@NotNull @NotNull PlanKey jobKey, long targetStageId, @NotNull @NotNull Expansion expansion, @NotNull @NotNull javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKey
- of job.targetStageId
- id of the stage the job is moving to.expansion
- the expansion.uriInfo
- URI info from the requestWebValidationException
Copyright © 2022 Atlassian Software Systems Pty Ltd. All rights reserved.