Package com.atlassian.bamboo.plugins.rest.plan.stage.job

Interface RestJobService

All Known Implementing Classes:

RestJobServiceImpl

public interface RestJobService

Service for job related REST stuff

Since:

v5.9

Method Summary

Modifier and Type	Method	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.

Method Detail

addJob

@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

Create a new job

Parameters:

planKey - of plan job is in

stageId - of stage job is in

restJob - Rest Job

expansion - the expansion.

uriInfo - URI info from the request

Returns:

Rest Job

Throws:

WebValidationException

updateJob

@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

Updates the details of a specific job. Will ignore missing properties.

Parameters:

jobKey - of job.

restJob - job details.

confirmationToken - The token to match before performing the update

expansion - the expansion.

uriInfo - URI info from the request

Returns:

updated job object

Throws:

WebValidationException

deleteJob

void deleteJob(@NotNull
               @NotNull PlanKey jobKey,
               @NotNull
               @NotNull Optional<ConfirmationToken> confirmationToken,
               @NotNull
               @NotNull javax.ws.rs.core.UriInfo uriInfo)
        throws WebValidationException

Remove a job.

Parameters:

jobKey - of job

confirmationToken - The token to match before performing the delete

uriInfo - URI info from the request

Throws:

ConflictException - if there is a token validation error

WebValidationException

getJobDeletionWarnings

@NotNull
@NotNull RestWarnings getJobDeletionWarnings(@NotNull
                                             @NotNull PlanKey jobKey,
                                             @NotNull
                                             @NotNull Expansion expansion,
                                             @NotNull
                                             @NotNull javax.ws.rs.core.UriInfo uriInfo)
                                      throws WebValidationException

Get warnings related to job deletion. This will return a structure with one entry for each artifact subscription. The entry for the artifact subscription will contain a list of all consuming jobs.

Parameters:

jobKey - of job

expansion - the expansion.

uriInfo - URI info from the request

Returns:

an object with information needed to display warnings to the user

Throws:

WebValidationException

getDeleteConfirmationToken

@NotNull
@NotNull Token getDeleteConfirmationToken(@NotNull
                                          @NotNull PlanKey jobKey,
                                          @NotNull
                                          @NotNull javax.ws.rs.core.UriInfo uriInfo)
                                   throws WebValidationException

Generate the delete confirmation token to be used for the given job key.

Parameters:

jobKey - job key to generate the token for.

uriInfo - URI info from the request

Returns:

current confirmation token.

Throws:

WebValidationException - if the job key is invalid.

getJobMoveWarnings

@NotNull
@NotNull RestWarnings getJobMoveWarnings(@NotNull
                                         @NotNull PlanKey jobKey,
                                         long targetStageId,
                                         @NotNull
                                         @NotNull Expansion expansion,
                                         @NotNull
                                         @NotNull javax.ws.rs.core.UriInfo uriInfo)
                                  throws WebValidationException

Get warnings related to job move. This will return a structure with one entry for each artifact subscription. The entry for the artifact subscription will contain a list of all consuming jobs.

Parameters:

jobKey - of job.

targetStageId - id of the stage the job is moving to.

expansion - the expansion.

uriInfo - URI info from the request

Returns:

an object with information needed to display warnings to the user

Throws:

WebValidationException