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

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      com.xebialabs.xlrelease.domain.environments.EnvironmentStage create​(com.xebialabs.xlrelease.domain.environments.EnvironmentStage environmentStage)
      Creates a new environment stage.
      com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView createStage​(com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)  
      void delete​(java.lang.String environmentStageId)
      Deletes an environment stage.
      com.xebialabs.xlrelease.domain.environments.EnvironmentStage getById​(java.lang.String environmentStageId)
      Gets an environment category by id.
      com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView getStageById​(java.lang.String environmentStageId)  
      java.util.List<com.xebialabs.xlrelease.domain.environments.EnvironmentStage> search​(com.xebialabs.xlrelease.api.v1.filter.EnvironmentStageFilters filters)
      Searches environment stages by filters.
      java.util.List<com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView> searchStages​(com.xebialabs.xlrelease.api.v1.filter.EnvironmentStageFilters filters)  
      default java.lang.String serviceName()  
      com.xebialabs.xlrelease.domain.environments.EnvironmentStage update​(com.xebialabs.xlrelease.domain.environments.EnvironmentStage environmentCategory)
      Updates an existing environment stage.
      com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView updateStage​(java.lang.String environmentStageId, com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)  

    • Method Detail

      • serviceName

        default java.lang.String serviceName()
        Specified by:
        serviceName in interface ApiService

      • createStage

        @POST
com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView createStage​(com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)

      • getStageById

        @GET
@Path("/{environmentStageId:.*/EnvironmentStage[^/]*}")
com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView getStageById​(@PathParam("environmentStageId")
                                                                       java.lang.String environmentStageId)

      • updateStage

        @PUT
@Path("/{environmentStageId:.*/EnvironmentStage[^/]*}")
com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView updateStage​(@PathParam("environmentStageId")
                                                                      java.lang.String environmentStageId,
                                                                      com.xebialabs.xlrelease.api.v1.form.EnvironmentStageForm stageForm)

      • searchStages

        @POST
@Path("/search")
java.util.List<com.xebialabs.xlrelease.api.v1.views.EnvironmentStageView> searchStages​(com.xebialabs.xlrelease.api.v1.filter.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

        com.xebialabs.xlrelease.domain.environments.EnvironmentStage create​(com.xebialabs.xlrelease.domain.environments.EnvironmentStage environmentStage)
        Creates a new environment stage.
        Parameters:
        environmentStage - an EnvironmentStage object describing the new environment category
        Returns:
        created EnvironmentStage object

      • getById

        com.xebialabs.xlrelease.domain.environments.EnvironmentStage getById​(java.lang.String environmentStageId)
        Gets an environment category by id.
        Parameters:
        environmentStageId - the environment stage identifier
        Returns:
        found EnvironmentStage object

      • update

        com.xebialabs.xlrelease.domain.environments.EnvironmentStage update​(com.xebialabs.xlrelease.domain.environments.EnvironmentStage environmentCategory)
        Updates an existing environment stage.
        Parameters:
        environmentCategory - an EnvironmentStage object describing the new properties of the environment category
        Returns:
        updated EnvironmentStage object

      • search

        java.util.List<com.xebialabs.xlrelease.domain.environments.EnvironmentStage> search​(com.xebialabs.xlrelease.api.v1.filter.EnvironmentStageFilters filters)
        Searches environment stages by filters.
        Parameters:
        filters - an EnvironmentStageFilters object describing the search criteria
        Returns:
        list of matching EnvironmentStages