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

Class PlanConfigResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.plan.PlanConfigResource

@Path("config/plan")
@Consumes("application/json")
@Produces("application/json")
@Internal
public class PlanConfigResource
extends Object

Provides RESTful operations for the configuration of build plans.

Since:

5.9

Field Summary

Fields

Modifier and Type	Field	Description
static final RestPageModel<RestJob>	ALL_JOBS
static final RestPlanConfig	PLAN_CONFIG	Used for REST documentation generation.

Constructor Summary

Constructors

Constructor	Description
PlanConfigResource(PlanService planService, JobService jobService, InputParser inputParser, PaginationService paginationService, PlanConversionFunction planConversionFunction, JobConversionFunction jobConversionFunction)

Method Summary

Modifier and Type	Method	Description
RestPageModel<RestJob>	getJobsForPlan(String planKeyString, ExpansionParam expansion, PageRequest pageRequest, jakarta.ws.rs.core.UriInfo uriInfo)	Retrieves all jobs for a build plan.
RestPlanConfig	getPlan(String planKeyString, ExpansionParam expansion, jakarta.ws.rs.core.UriInfo uriInfo)	Gets the details of a build plan configuration.

Methods inherited from class java.lang.Object

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

Field Details

PLAN_CONFIG

public static final RestPlanConfig PLAN_CONFIG

Used for REST documentation generation.

ALL_JOBS

public static final RestPageModel<RestJob> ALL_JOBS

Constructor Details

PlanConfigResource

@Inject
public PlanConfigResource(PlanService planService,
 JobService jobService,
 InputParser inputParser,
 PaginationService paginationService,
 PlanConversionFunction planConversionFunction,
 JobConversionFunction jobConversionFunction)

Method Details

getPlan

@GET
@Path("{planKey}")
public RestPlanConfig getPlan(@PathParam("planKey")
 String planKeyString,
 @BeanParam
 ExpansionParam expansion,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                       throws WebValidationException

Gets the details of a build plan configuration.

Parameters:

planKeyString - key of the build plan to get the configuration for

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

Returns:

RestPlan a representation of the configuration of a build plan

Throws:

WebValidationException

getJobsForPlan

@GET
@Path("{planKey}/job")
public RestPageModel<RestJob> getJobsForPlan(@PathParam("planKey")
 String planKeyString,
 @BeanParam
 ExpansionParam expansion,
 @BeanParam
 PageRequest pageRequest,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

Retrieves all jobs for a build plan.

Parameters:

planKeyString - key of the plan to retrieve jobs 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 - provides access to application and request URI information

Returns:

a paginated representation of a RestJob