Class RequirementResource
- java.lang.Object
-
- com.atlassian.bamboo.plugins.rest.plan.stage.job.requirement.RequirementResource
-
@Internal public class RequirementResource extends Object
Provides RESTful operations on build requirements.- Since:
- 5.9
-
-
Field Summary
Fields Modifier and Type Field Description static RestAgentSummary
AGENT_SUMMARY
static RestRequirement
REQUIREMENT
Used for REST documentation generation.static List<RestRequirement>
REQUIREMENTS
-
Constructor Summary
Constructors Constructor Description RequirementResource(RequirementService requirementService, BambooPermissionManager bambooPermissionManager, FeatureManager featureManager, InputParser inputParser, LinkService linkService, PlanRestService planRestService)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method 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.RestAgentSummary
getDetailedAgentMatchesForJob(String jobKeyString, javax.ws.rs.core.UriInfo uriInfo)
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.
-
-
-
Field Detail
-
REQUIREMENT
public static final RestRequirement REQUIREMENT
Used for REST documentation generation.
-
REQUIREMENTS
public static final List<RestRequirement> REQUIREMENTS
-
AGENT_SUMMARY
public static final RestAgentSummary AGENT_SUMMARY
-
-
Constructor Detail
-
RequirementResource
public RequirementResource(RequirementService requirementService, BambooPermissionManager bambooPermissionManager, FeatureManager featureManager, InputParser inputParser, LinkService linkService, PlanRestService planRestService)
-
-
Method Detail
-
getAgentMatchesForJob
public RestAgentSummary getAgentMatchesForJob(String jobKeyString, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
Gets a summary of the agents that are capable of running a job, based off its requirements.- Parameters:
jobKeyString
- job key of the job- Returns:
RestAgentSummary
- Throws:
WebValidationException
-
getDetailedAgentMatchesForJob
public RestAgentSummary getDetailedAgentMatchesForJob(String jobKeyString, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
- Throws:
WebValidationException
-
getRequirementsForJob
public List<RestRequirement> getRequirementsForJob(String jobKeyString) throws WebValidationException
Gets all the requirements of a job.- Parameters:
jobKeyString
- job key of the job- Returns:
- a list of
RestRequirement
- Throws:
WebValidationException
-
getRequirementForJob
public RestRequirement getRequirementForJob(String jobKeyString, long requirementId, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
Gets the details of a requirement for a given job.- Parameters:
jobKeyString
- job key of the jobrequirementId
- unique identifier of the requirement to get details of- Returns:
RestRequirement
- Throws:
WebValidationException
-
addRequirementForJob
public RestRequirement addRequirementForJob(String jobKeyString, RestRequirement requirement, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
Adds a requirement for a given job.- Parameters:
jobKeyString
- job key of the jobrequirement
- a representation of the requirement- Returns:
RestRequirement
- Throws:
WebValidationException
-
updateRequirementForJob
public RestRequirement updateRequirementForJob(String jobKeyString, long requirementId, RestRequirement requirement, @Context javax.ws.rs.core.UriInfo uriInfo) throws WebValidationException
Updates a requirement for a given job.- Parameters:
jobKeyString
- job key of the jobrequirementId
- requirement id of the requirement to updaterequirement
- an updated representation of the requirement- Returns:
RestRequirement
- Throws:
WebValidationException
-
removeRequirementFromJob
public javax.ws.rs.core.Response removeRequirementFromJob(String jobKeyString, long requirementId) throws WebValidationException
Removes a requirement for a job.- Parameters:
jobKeyString
- key of the jobrequirementId
- requirement id of the requirement to delete- Returns:
Response
an empty response- Throws:
WebValidationException
-
-