@ExperimentalApi public class PlanConfigResource extends Object
Modifier and Type | Field and Description |
---|---|
static RestPageModel<RestJob> |
ALL_JOBS |
static RestPlanConfig |
PLAN_CONFIG
Used for REST documentation generation.
|
Constructor and Description |
---|
PlanConfigResource(PlanService planService,
JobService jobService,
InputParser inputParser,
PaginationService paginationService,
PlanConversionFunction planConversionFunction,
JobConversionFunction jobConversionFunction) |
Modifier and Type | Method and Description |
---|---|
RestPageModel<RestJob> |
getJobsForPlan(String planKeyString,
Expansion expansion,
PageRequest pageRequest,
javax.ws.rs.core.UriInfo uriInfo)
Retrieves all jobs for a build plan.
|
RestPlanConfig |
getPlan(String planKeyString,
Expansion expansion,
javax.ws.rs.core.UriInfo uriInfo)
Gets the details of a build plan configuration.
|
public static final RestPlanConfig PLAN_CONFIG
public static final RestPageModel<RestJob> ALL_JOBS
public PlanConfigResource(PlanService planService, JobService jobService, InputParser inputParser, PaginationService paginationService, PlanConversionFunction planConversionFunction, JobConversionFunction jobConversionFunction)
public RestPlanConfig getPlan(String planKeyString, @Context Expansion expansion, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
planKeyString
- key of the build plan to get the configuration forexpansion
- represents an expansion tree of additional information we want to retrieveRestPlan
a representation of the configuration of a build planWebValidationException
public RestPageModel<RestJob> getJobsForPlan(String planKeyString, @Context Expansion expansion, @Context PageRequest pageRequest, @Context javax.ws.rs.core.UriInfo uriInfo)
planKeyString
- key of the plan to retrieve jobs forexpansion
- represents an expansion tree of additional information we want to retrievepageRequest
- represents the params that define which page the request is afteruriInfo
- provides access to application and request URI informationRestJob
Copyright © 2020 Atlassian Software Systems Pty Ltd. All rights reserved.