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

Class DeploymentEnvironmentResource

java.lang.Object

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

@Path("deploy/environment")
@Consumes("application/json")
@Produces("application/json")
@Singleton
public class DeploymentEnvironmentResource
extends Object

Constructor Summary

Constructors

Constructor

Description

DeploymentEnvironmentResource(AgentAssignmentService agentAssignmentService, AgentManager agentManager, CachedEnvironmentService cachedEnvironmentService, EnvironmentService environmentService, EnvironmentCustomConfigService environmentCustomConfigService, DeploymentResultService deploymentResultService, CachedDeploymentProjectService cachedDeploymentProjectService, com.atlassian.sal.api.message.I18nResolver i18nResolver, com.atlassian.event.api.EventPublisher eventPublisher, ElasticImageConfigurationManager elasticImageConfigurationManager, EnvironmentRequirementService environmentRequirementService, VariableDefinitionManager variableDefinitionManager, AdministrationConfigurationAccessor administrationConfigurationAccessor, BambooPermissionManager bambooPermissionManager, VariableConfigurationService variableConfigurationService, AgentCapabilityService agentCapabilityService, LinkService linkService, EphemeralAgentsService ephemeralAgentsService)

Method Summary

Modifier and Type	Method	Description
RestAgentAssignmentExecutorDetails	addAgentAssignmentForEnvironment(long environmentId, Map<String,String> agentAssignmentKey)
jakarta.ws.rs.core.Response	createEnvironmentVariable(Long environmentId, @Nullable RestVariable variable)
jakarta.ws.rs.core.Response	deleteEnvironmentVariable(Long environmentId, String variableName)
List<RestAgentAssignmentExecutorDetails>	findAssignedAgentsByEnvironment(long environmentId)
jakarta.ws.rs.core.Response	findPossibleAgentsForEnvironment(long environmentId, @Nullable String searchTerm, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	getAllEnvironmentVariables(Long environmentId)
RestDeploymentResultList	getDeploymentResultList(long environmentId, String expandParam, jakarta.ws.rs.core.UriInfo uriInfo)
RestDockerPipelineConfiguration	getDockerPipelinesConfiguration(long environmentId)
RestEnvironmentWithConfigCounts	getEnvironment(long environmentId)
RestPageModel<RestEnvironmentForExecutablesView>	getEnvironmentsExecutableByAgent(String filter, long agentId, PageRequest pageRequest, jakarta.ws.rs.core.UriInfo uriInfo)
RestPageModel<RestEnvironmentForExecutablesView>	getEnvironmentsExecutableByElasticConfiguration(String filter, Long configurationId, PageRequest pageRequest, jakarta.ws.rs.core.UriInfo uriInfo)
RestPageModel<RestEnvironmentForExecutablesView>	getEnvironmentsExecutableByEphemeralAgentTemplate(String filter, Long templateId, PageRequest pageRequest, jakarta.ws.rs.core.UriInfo uriInfo)
jakarta.ws.rs.core.Response	getEnvironmentVariable(Long environmentId, String variableName)
jakarta.ws.rs.core.Response	moveEnvironment(Long environmentId, @Nullable String positionString, Long relativeEnvironmentId)
jakarta.ws.rs.core.Response	removeAgentAssignmentFromEnvironment(long environmentId, String executorKey)
jakarta.ws.rs.core.Response	saveDockerPipelinesConfiguration(long environmentId, RestDockerPipelineConfiguration restDockerPipelineConfiguration)
jakarta.ws.rs.core.Response	updateEnvironmentPrerequisites(Long environmentId, @NotNull RestEnvironmentPrerequisites restEnvironmentPrerequisites)
jakarta.ws.rs.core.Response	updateEnvironmentVariable(Long environmentId, String variableName, @Nullable RestVariable variable)

Methods inherited from class java.lang.Object

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

Constructor Details

DeploymentEnvironmentResource

@Inject
public DeploymentEnvironmentResource(AgentAssignmentService agentAssignmentService,
 AgentManager agentManager,
 CachedEnvironmentService cachedEnvironmentService,
 EnvironmentService environmentService,
 EnvironmentCustomConfigService environmentCustomConfigService,
 DeploymentResultService deploymentResultService,
 CachedDeploymentProjectService cachedDeploymentProjectService,
 com.atlassian.sal.api.message.I18nResolver i18nResolver,
 com.atlassian.event.api.EventPublisher eventPublisher,
 ElasticImageConfigurationManager elasticImageConfigurationManager,
 EnvironmentRequirementService environmentRequirementService,
 VariableDefinitionManager variableDefinitionManager,
 AdministrationConfigurationAccessor administrationConfigurationAccessor,
 BambooPermissionManager bambooPermissionManager,
 VariableConfigurationService variableConfigurationService,
 AgentCapabilityService agentCapabilityService,
 LinkService linkService,
 EphemeralAgentsService ephemeralAgentsService)

Method Details

getEnvironment

@GET
@Path("{environmentId}")
public RestEnvironmentWithConfigCounts getEnvironment(@PathParam("environmentId")
 long environmentId)

getEnvironmentsExecutableByAgent

@GET
@Path("agent/{agentId}")
public RestPageModel<RestEnvironmentForExecutablesView> getEnvironmentsExecutableByAgent(@QueryParam("filter") @DefaultValue("")
 String filter,
 @PathParam("agentId")
 long agentId,
 @BeanParam
 PageRequest pageRequest,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getEnvironmentsExecutableByElasticConfiguration

@GET
@Path("elasticImageConfiguration/{configurationId}")
public RestPageModel<RestEnvironmentForExecutablesView> getEnvironmentsExecutableByElasticConfiguration(@QueryParam("filter") @DefaultValue("")
 String filter,
 @PathParam("configurationId")
 Long configurationId,
 @BeanParam
 PageRequest pageRequest,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getEnvironmentsExecutableByEphemeralAgentTemplate

@GET
@Path("ephemeral/{templateId}")
public RestPageModel<RestEnvironmentForExecutablesView> getEnvironmentsExecutableByEphemeralAgentTemplate(@QueryParam("filter") @DefaultValue("")
 String filter,
 @PathParam("templateId")
 Long templateId,
 @BeanParam
 PageRequest pageRequest,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

getDeploymentResultList

@GET
@Path("{environmentId}/results")
public RestDeploymentResultList getDeploymentResultList(@PathParam("environmentId")
 long environmentId,
 @QueryParam("expand")
 String expandParam,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

findAssignedAgentsByEnvironment

@GET
@Path("{environmentId}/agent-assignment")
public List<RestAgentAssignmentExecutorDetails> findAssignedAgentsByEnvironment(@PathParam("environmentId")
 long environmentId)

findPossibleAgentsForEnvironment

@GET
@Path("{environmentId}/possible-agent-assignment")
public jakarta.ws.rs.core.Response findPossibleAgentsForEnvironment(@PathParam("environmentId")
 long environmentId,
 @Nullable @QueryParam("searchTerm")
 @Nullable String searchTerm,
 @Context
 jakarta.ws.rs.core.UriInfo uriInfo)

addAgentAssignmentForEnvironment

@POST
@Path("{environmentId}/agent-assignment")
public RestAgentAssignmentExecutorDetails addAgentAssignmentForEnvironment(@PathParam("environmentId")
 long environmentId,
 Map<String,String> agentAssignmentKey)
                                                                    throws WebValidationException

Throws:

WebValidationException

removeAgentAssignmentFromEnvironment

@DELETE
@Path("{environmentId}/agent-assignment/{executorKey}")
public jakarta.ws.rs.core.Response removeAgentAssignmentFromEnvironment(@PathParam("environmentId")
 long environmentId,
 @PathParam("executorKey")
 String executorKey)
                                                                 throws WebValidationException

Throws:

WebValidationException

getDockerPipelinesConfiguration

@GET
@Path("{environmentId}/docker")
public RestDockerPipelineConfiguration getDockerPipelinesConfiguration(@PathParam("environmentId")
 long environmentId)

saveDockerPipelinesConfiguration

@PUT
@Path("{environmentId}/docker")
public jakarta.ws.rs.core.Response saveDockerPipelinesConfiguration(@PathParam("environmentId")
 long environmentId,
 RestDockerPipelineConfiguration restDockerPipelineConfiguration)

moveEnvironment

@POST
@Path("{environmentId}/move/{position}/{relativeEnvironmentId}")
public jakarta.ws.rs.core.Response moveEnvironment(@PathParam("environmentId")
 Long environmentId,
 @PathParam("position") @Nullable
 @Nullable String positionString,
 @PathParam("relativeEnvironmentId")
 Long relativeEnvironmentId)
                                            throws WebValidationException,
NotFoundException

Throws:

WebValidationException

NotFoundException

getAllEnvironmentVariables

@GET
@Path("{environmentId}/variables")
public jakarta.ws.rs.core.Response getAllEnvironmentVariables(@PathParam("environmentId")
 Long environmentId)

getEnvironmentVariable

@GET
@Path("{environmentId}/variable/{variableName}")
public jakarta.ws.rs.core.Response getEnvironmentVariable(@PathParam("environmentId")
 Long environmentId,
 @PathParam("variableName")
 String variableName)

createEnvironmentVariable

@POST
@Path("{environmentId}/variable")
public jakarta.ws.rs.core.Response createEnvironmentVariable(@PathParam("environmentId")
 Long environmentId,
 @Nullable
 @Nullable RestVariable variable)

updateEnvironmentVariable

@PUT
@Path("{environmentId}/variable/{variableName}")
public jakarta.ws.rs.core.Response updateEnvironmentVariable(@PathParam("environmentId")
 Long environmentId,
 @PathParam("variableName")
 String variableName,
 @Nullable
 @Nullable RestVariable variable)

deleteEnvironmentVariable

@DELETE
@Path("{environmentId}/variable/{variableName}")
public jakarta.ws.rs.core.Response deleteEnvironmentVariable(@PathParam("environmentId")
 Long environmentId,
 @PathParam("variableName")
 String variableName)

updateEnvironmentPrerequisites

@PUT
@Path("{environmentId}/prerequisites")
public jakarta.ws.rs.core.Response updateEnvironmentPrerequisites(@PathParam("environmentId")
 Long environmentId,
 @NotNull
 @NotNull RestEnvironmentPrerequisites restEnvironmentPrerequisites)