@Path(value="config/job/{jobKey}/requirement") @Consumes(value="application/json") @Produces(value="application/json") @ExperimentalApi public class RequirementResource extends Object
Modifier and Type | Field and Description |
---|---|
static RestAgentSummary |
AGENT_SUMMARY |
static RestRequirement |
REQUIREMENT
Used for REST documentation generation.
|
static List<RestRequirement> |
REQUIREMENTS |
Constructor and Description |
---|
RequirementResource(RequirementService requirementService,
BambooPermissionManager bambooPermissionManager,
FeatureManager featureManager,
InputParser inputParser,
LinkService linkService) |
Modifier and Type | Method and Description |
---|---|
RestRequirement |
addRequirementForJob(String jobKeyString,
RestRequirement requirement,
javax.ws.rs.core.UriInfo uriInfo)
Adds a requirement for a given job.
|
RestAgentSummary |
getAgentMatchesForJob(String jobKeyString,
javax.ws.rs.core.UriInfo uriInfo)
Gets a summary of the agents that are capable of running a job, based off its requirements.
|
RestRequirement |
getRequirementForJob(String jobKeyString,
long requirementId,
javax.ws.rs.core.UriInfo uriInfo)
Gets the details of a requirement for a given job.
|
List<RestRequirement> |
getRequirementsForJob(String jobKeyString)
Gets all the requirements of a job.
|
javax.ws.rs.core.Response |
removeRequirementFromJob(String jobKeyString,
long requirementId)
Removes a requirement for a job.
|
RestRequirement |
updateRequirementForJob(String jobKeyString,
long requirementId,
RestRequirement requirement,
javax.ws.rs.core.UriInfo uriInfo)
Updates a requirement for a given job.
|
public static final RestRequirement REQUIREMENT
public static final List<RestRequirement> REQUIREMENTS
public static final RestAgentSummary AGENT_SUMMARY
public RequirementResource(RequirementService requirementService, BambooPermissionManager bambooPermissionManager, FeatureManager featureManager, InputParser inputParser, LinkService linkService)
@GET @Path(value="summary") public RestAgentSummary getAgentMatchesForJob(@PathParam(value="jobKey") String jobKeyString, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKeyString
- job key of the jobRestAgentSummary
WebValidationException
@GET public List<RestRequirement> getRequirementsForJob(@PathParam(value="jobKey") String jobKeyString) throws WebValidationException
jobKeyString
- job key of the jobRestRequirement
WebValidationException
@GET @Path(value="{id}") public RestRequirement getRequirementForJob(@PathParam(value="jobKey") String jobKeyString, @PathParam(value="id") long requirementId, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKeyString
- job key of the jobrequirementId
- unique identifier of the requirement to get details ofRestRequirement
WebValidationException
@POST public RestRequirement addRequirementForJob(@PathParam(value="jobKey") String jobKeyString, RestRequirement requirement, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKeyString
- job key of the jobrequirement
- a representation of the requirementRestRequirement
WebValidationException
@PUT @Path(value="{id}") public RestRequirement updateRequirementForJob(@PathParam(value="jobKey") String jobKeyString, @PathParam(value="id") long requirementId, RestRequirement requirement, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
jobKeyString
- job key of the jobrequirementId
- requirement id of the requirement to updaterequirement
- an updated representation of the requirementRestRequirement
WebValidationException
@DELETE @Path(value="{id}") public javax.ws.rs.core.Response removeRequirementFromJob(@PathParam(value="jobKey") String jobKeyString, @PathParam(value="id") long requirementId) throws WebValidationException
jobKeyString
- key of the jobrequirementId
- requirement id of the requirement to deleteResponse
an empty responseWebValidationException
Copyright © 2016 Atlassian Software Systems Pty Ltd. All rights reserved.