Package com.xebialabs.xlrelease.api.v1
Interface EnvironmentApi
- All Superinterfaces:
ApiService
@Path("/api/v1/environments")
@Consumes("application/json")
@Produces("application/json")
public interface EnvironmentApi
extends ApiService
-
Field Summary
Fields inherited from interface com.xebialabs.xlrelease.api.ApiService
DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA
-
Method Summary
Modifier and TypeMethodDescriptioncreate
(Environment environment) Creates a new environment.createEnvironment
(EnvironmentForm environmentForm) void
Deletes an environment.Gets an environment by id.getDeployableApplications
(String environmentId) Gets all applications that are allowed to be deployed for a given environmentgetDeployableApplicationsForEnvironment
(String environmentId) getEnvironment
(String environmentId) getReservations
(String environmentId) Gets all environment reservations for a given environment.getReservationsForEnvironment
(String environmentId) search
(EnvironmentFilters filters) Searches environments by filters.searchEnvironments
(EnvironmentFilters environmentFilters) default String
update
(Environment environment) Updates an existing environment.updateEnvironment
(String environmentId, EnvironmentForm environmentForm)
-
Method Details
-
serviceName
- Specified by:
serviceName
in interfaceApiService
-
createEnvironment
-
getEnvironment
@GET @Path("/{environmentId:.*/Environment[^/]*}") EnvironmentView getEnvironment(@PathParam("environmentId") String environmentId) -
updateEnvironment
@PUT @Path("/{environmentId:.*/Environment[^/]*}") EnvironmentView updateEnvironment(@PathParam("environmentId") String environmentId, EnvironmentForm environmentForm) -
searchEnvironments
@POST @Path("/search") List<EnvironmentView> searchEnvironments(EnvironmentFilters environmentFilters) -
getReservationsForEnvironment
@GET @Path("/{environmentId:.*/Environment[^/]*}/reservations") List<EnvironmentReservationView> getReservationsForEnvironment(@PathParam("environmentId") String environmentId) -
getDeployableApplicationsForEnvironment
@GET @Path("/{environmentId:.*/Environment[^/]*}/applications") List<BaseApplicationView> getDeployableApplicationsForEnvironment(@PathParam("environmentId") String environmentId) -
delete
@DELETE @Path("/{environmentId:.*/Environment[^/]*}") void delete(@PathParam("environmentId") String environmentId) Deletes an environment.- Parameters:
environmentId
- the environment identifier
-
create
Creates a new environment.- Parameters:
environment
- anEnvironment
object describing the new environment- Returns:
- created
Environment
object
-
getById
Gets an environment by id.- Parameters:
environmentId
- the environment identifier- Returns:
- found
Environment
object
-
update
Updates an existing environment.- Parameters:
environment
- anEnvironment
object describing the new properties of the environment- Returns:
- updated
Environment
object
-
search
Searches environments by filters.- Parameters:
filters
- anEnvironmentFilters
object describing the search criteria- Returns:
- list of matching
Environment
s
-
getReservations
Gets all environment reservations for a given environment.- Parameters:
environmentId
- the environment identifier- Returns:
- list of matching
EnvironmentReservation
s
-
getDeployableApplications
Gets all applications that are allowed to be deployed for a given environment- Parameters:
environmentId
- the environment identifier- Returns:
- list of matching
Application
s
-