Package com.xebialabs.xlrelease.api.v1
Interface EnvironmentStageApi
-
- All Superinterfaces:
ApiService
@Path("/api/v1/environments/stages") @Consumes("application/json") @Produces("application/json") public interface EnvironmentStageApi 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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description EnvironmentStage
create(EnvironmentStage environmentStage)
Creates a new environment stage.EnvironmentStageView
createStage(EnvironmentStageForm stageForm)
void
delete(java.lang.String environmentStageId)
Deletes an environment stage.EnvironmentStage
getById(java.lang.String environmentStageId)
Gets an environment category by id.EnvironmentStageView
getStageById(java.lang.String environmentStageId)
java.util.List<EnvironmentStage>
search(EnvironmentStageFilters filters)
Searches environment stages by filters.java.util.List<EnvironmentStageView>
searchStages(EnvironmentStageFilters filters)
default java.lang.String
serviceName()
EnvironmentStage
update(EnvironmentStage environmentCategory)
Updates an existing environment stage.EnvironmentStageView
updateStage(java.lang.String environmentStageId, EnvironmentStageForm stageForm)
-
-
-
Method Detail
-
serviceName
default java.lang.String serviceName()
- Specified by:
serviceName
in interfaceApiService
-
createStage
@POST EnvironmentStageView createStage(EnvironmentStageForm stageForm)
-
getStageById
@GET @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") EnvironmentStageView getStageById(@PathParam("environmentStageId") java.lang.String environmentStageId)
-
updateStage
@PUT @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") EnvironmentStageView updateStage(@PathParam("environmentStageId") java.lang.String environmentStageId, EnvironmentStageForm stageForm)
-
searchStages
@POST @Path("/search") java.util.List<EnvironmentStageView> searchStages(EnvironmentStageFilters filters)
-
delete
@DELETE @Path("/{environmentStageId:.*/EnvironmentStage[^/]*}") void delete(@PathParam("environmentStageId") java.lang.String environmentStageId)
Deletes an environment stage.- Parameters:
environmentStageId
- the environment stage identifier
-
create
EnvironmentStage create(EnvironmentStage environmentStage)
Creates a new environment stage.- Parameters:
environmentStage
- anEnvironmentStage
object describing the new environment category- Returns:
- created
EnvironmentStage
object
-
getById
EnvironmentStage getById(java.lang.String environmentStageId)
Gets an environment category by id.- Parameters:
environmentStageId
- the environment stage identifier- Returns:
- found
EnvironmentStage
object
-
update
EnvironmentStage update(EnvironmentStage environmentCategory)
Updates an existing environment stage.- Parameters:
environmentCategory
- anEnvironmentStage
object describing the new properties of the environment category- Returns:
- updated
EnvironmentStage
object
-
search
java.util.List<EnvironmentStage> search(EnvironmentStageFilters filters)
Searches environment stages by filters.- Parameters:
filters
- anEnvironmentStageFilters
object describing the search criteria- Returns:
- list of matching
EnvironmentStage
s
-
-