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

Class TaskConfigResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.plan.stage.job.task.TaskConfigResource

@Internal
public class TaskConfigResource
extends Object

Provides RESTful operations on tasks for the configuration of build plans.

Since:

5.10

Field Summary

Fields

Modifier and Type	Field	Description
static List<RestTask>	ALL_TASKS
static RestTask	TASK	Used for REST documentation generation.

Constructor Summary

Constructors

Constructor	Description
TaskConfigResource(com.atlassian.sal.api.message.I18nResolver i18nResolver, InputParser inputParser, JobService jobService, TaskService taskService, CachedPlanManager cachedPlanManager, PaginationService paginationService, TaskConversionFunction taskConversionFunction)

Method Summary

Modifier and Type	Method	Description
RestPageModel<RestTask>	getAllTasksForJob(String planKeyString, long stageId, String jobKeyString, Expansion expansion, PageRequest pageRequest, javax.ws.rs.core.UriInfo uriInfo)	Return all tasks for a given job.
RestTask	getTaskFromJob(String planKeyString, long stageId, String jobKeyString, long taskId, Expansion expansion, javax.ws.rs.core.UriInfo uriInfo)	Return a task from a given job.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TASK

public static final RestTask TASK

Used for REST documentation generation.

ALL_TASKS

public static final List<RestTask> ALL_TASKS

Constructor Detail

TaskConfigResource

public TaskConfigResource(com.atlassian.sal.api.message.I18nResolver i18nResolver,
                          InputParser inputParser,
                          JobService jobService,
                          TaskService taskService,
                          CachedPlanManager cachedPlanManager,
                          PaginationService paginationService,
                          TaskConversionFunction taskConversionFunction)

Method Detail

getAllTasksForJob

public RestPageModel<RestTask> getAllTasksForJob(String planKeyString,
                                                 long stageId,
                                                 String jobKeyString,
                                                 @Context
                                                 Expansion expansion,
                                                 @Context
                                                 PageRequest pageRequest,
                                                 @Context
                                                 javax.ws.rs.core.UriInfo uriInfo)

Return all tasks for a given job. This will return an ordered list of tasks, beginning with the regular tasks and followed by the finalized tasks.

Parameters:

planKeyString - plan to retrieve tasks for

stageId - stage to retrieve tasks for

jobKeyString - job to retrieve tasks for

expansion - represents an expansion tree of additional information we want to retrieve

pageRequest - represents the params that define which page the request is after

uriInfo - the URI info for the request

Returns:

an ordered list of RestTask

getTaskFromJob

public RestTask getTaskFromJob(String planKeyString,
                               long stageId,
                               String jobKeyString,
                               long taskId,
                               @Context
                               Expansion expansion,
                               @Context
                               javax.ws.rs.core.UriInfo uriInfo)

Return a task from a given job.

Parameters:

planKeyString - plan to retrieve the task from

stageId - stage to retrieve the task from

jobKeyString - job to retrieve the task from

taskId - id of the task to retrieve

expansion - represents an expansion tree of additional information we want to retrieve

uriInfo - the URI info for the request

Returns:

a RestTask