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

Class RequirementResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.plan.stage.job.requirement.RequirementResource

@Path("config/job/{jobKey}/requirement")
@Consumes("application/json")
@Produces("application/json")
@Internal
public class RequirementResource
extends Object

Provides RESTful operations on build requirements.

Since:

5.9

Field Summary

Fields

Modifier and Type	Field	Description
static final RestAgentSummary	AGENT_SUMMARY
static final RestRequirement	REQUIREMENT	Used for REST documentation generation.
static final List<RestRequirement>	REQUIREMENTS

Constructor Summary

Constructors

Constructor	Description
RequirementResource(RequirementService requirementService, BambooPermissionManager bambooPermissionManager, FeatureManager featureManager, InputParser inputParser, LinkService linkService, PlanRestService planRestService)

Method Summary

Modifier and Type	Method	Description
RestRequirement	addRequirementForJob(String jobKeyString, RestRequirement requirement, jakarta.ws.rs.core.UriInfo uriInfo)	Adds a requirement for a given job.
RestAgentSummary	getAgentMatchesForJob(String jobKeyString, jakarta.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, jakarta.ws.rs.core.UriInfo uriInfo)
RestRequirement	getRequirementForJob(String jobKeyString, long requirementId, jakarta.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.
jakarta.ws.rs.core.Response	removeRequirementFromJob(String jobKeyString, long requirementId)	Removes a requirement for a job.
RestRequirement	updateRequirementForJob(String jobKeyString, long requirementId, RestRequirement requirement, jakarta.ws.rs.core.UriInfo uriInfo)	Updates a requirement for a given job.

Methods inherited from class java.lang.Object

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

Field Details

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 Details

RequirementResource

@Inject
public RequirementResource(RequirementService requirementService,
 BambooPermissionManager bambooPermissionManager,
 FeatureManager featureManager,
 InputParser inputParser,
 LinkService linkService,
 PlanRestService planRestService)

Method Details

getAgentMatchesForJob

@GET
@Path("summary")
public RestAgentSummary getAgentMatchesForJob(@PathParam("jobKey")
 String jobKeyString,
 @Context
 jakarta.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

@GET
@Path("detailedSummary")
public RestAgentSummary getDetailedAgentMatchesForJob(@PathParam("jobKey")
 String jobKeyString,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                               throws WebValidationException

Throws:

WebValidationException

getRequirementsForJob

@GET
public List<RestRequirement> getRequirementsForJob(@PathParam("jobKey")
 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

@GET
@Path("{id}")
public RestRequirement getRequirementForJob(@PathParam("jobKey")
 String jobKeyString,
 @PathParam("id")
 long requirementId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                     throws WebValidationException

Gets the details of a requirement for a given job.

Parameters:

jobKeyString - job key of the job

requirementId - unique identifier of the requirement to get details of

Returns:

RestRequirement

Throws:

WebValidationException

addRequirementForJob

@POST
public RestRequirement addRequirementForJob(@PathParam("jobKey")
 String jobKeyString,
 RestRequirement requirement,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                     throws WebValidationException

Adds a requirement for a given job.

Parameters:

jobKeyString - job key of the job

requirement - a representation of the requirement

Returns:

RestRequirement

Throws:

WebValidationException

updateRequirementForJob

@PUT
@Path("{id}")
public RestRequirement updateRequirementForJob(@PathParam("jobKey")
 String jobKeyString,
 @PathParam("id")
 long requirementId,
 RestRequirement requirement,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                        throws WebValidationException

Updates a requirement for a given job.

Parameters:

jobKeyString - job key of the job

requirementId - requirement id of the requirement to update

requirement - an updated representation of the requirement

Returns:

RestRequirement

Throws:

WebValidationException

removeRequirementFromJob

@DELETE
@Path("{id}")
public jakarta.ws.rs.core.Response removeRequirementFromJob(@PathParam("jobKey")
 String jobKeyString,
 @PathParam("id")
 long requirementId)
                                                     throws WebValidationException

Removes a requirement for a job.

Parameters:

jobKeyString - key of the job

requirementId - requirement id of the requirement to delete

Returns:

Response an empty response

Throws:

WebValidationException