Package com.atlassian.bamboo.plugins.rest.deployments.environments

Class EnvironmentRequirementResource

java.lang.Object

com.atlassian.bamboo.plugins.rest.deployments.environments.EnvironmentRequirementResource

@Path("deploy/environment/{environmentId}/requirement")
@Consumes("application/json")
@Produces("application/json")
@ExperimentalApi
public class EnvironmentRequirementResource
extends Object

Provides RESTful operations on deployment environment requirements.

Since:

5.13

Constructor Summary

Constructors

Constructor	Description
EnvironmentRequirementResource(CachedDeploymentProjectService cachedDeploymentProjectService, EnvironmentRequirementService environmentRequirementService, CachedEnvironmentService cachedEnvironmentService, BambooPermissionManager bambooPermissionManager, FeatureManager featureManager, LinkService linkService)

Method Summary

Modifier and Type	Method	Description
RestRequirement	addRequirementForEnvironment(long environmentId, RestRequirement requirement, jakarta.ws.rs.core.UriInfo uriInfo)
RestAgentSummary	getAgentMatchesForEnvironment(long environmentId, jakarta.ws.rs.core.UriInfo uriInfo)
RestAgentSummary	getDetailedAgentMatchesForEnvironment(long environmentId, jakarta.ws.rs.core.UriInfo uriInfo)
RestRequirement	getRequirementForEnvironment(long environmentId, long requirementId, jakarta.ws.rs.core.UriInfo uriInfo)
List<RestRequirement>	getRequirementsForEnvironment(long environmentId)
jakarta.ws.rs.core.Response	removeRequirementFromEnvironment(long environmentId, long requirementId)
RestRequirement	updateRequirementForEnvironment(long environmentId, long requirementId, RestRequirement requirement, jakarta.ws.rs.core.UriInfo uriInfo)

Methods inherited from class java.lang.Object

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

Constructor Details

EnvironmentRequirementResource

@Inject
public EnvironmentRequirementResource(CachedDeploymentProjectService cachedDeploymentProjectService,
 EnvironmentRequirementService environmentRequirementService,
 CachedEnvironmentService cachedEnvironmentService,
 BambooPermissionManager bambooPermissionManager,
 FeatureManager featureManager,
 LinkService linkService)

Method Details

getAgentMatchesForEnvironment

@GET
@Path("summary")
public RestAgentSummary getAgentMatchesForEnvironment(@PathParam("environmentId")
 long environmentId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                               throws WebValidationException

Throws:

WebValidationException

getDetailedAgentMatchesForEnvironment

@GET
@Path("detailedSummary")
public RestAgentSummary getDetailedAgentMatchesForEnvironment(@PathParam("environmentId")
 long environmentId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                                       throws WebValidationException

Throws:

WebValidationException

getRequirementsForEnvironment

@GET
public List<RestRequirement> getRequirementsForEnvironment(@PathParam("environmentId")
 long environmentId)
                                                    throws WebValidationException

Throws:

WebValidationException

getRequirementForEnvironment

@GET
@Path("{requirementId}")
public RestRequirement getRequirementForEnvironment(@PathParam("environmentId")
 long environmentId,
 @PathParam("requirementId")
 long requirementId,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                             throws WebValidationException

Throws:

WebValidationException

addRequirementForEnvironment

@POST
public RestRequirement addRequirementForEnvironment(@PathParam("environmentId")
 long environmentId,
 RestRequirement requirement,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                             throws WebValidationException

Throws:

WebValidationException

updateRequirementForEnvironment

@PUT
@Path("{requirementId}")
public RestRequirement updateRequirementForEnvironment(@PathParam("environmentId")
 long environmentId,
 @PathParam("requirementId")
 long requirementId,
 RestRequirement requirement,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)
                                                throws WebValidationException

Throws:

WebValidationException

removeRequirementFromEnvironment

@DELETE
@Path("{requirementId}")
public jakarta.ws.rs.core.Response removeRequirementFromEnvironment(@PathParam("environmentId")
 long environmentId,
 @PathParam("requirementId")
 long requirementId)
                                                             throws WebValidationException

Throws:

WebValidationException