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

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      com.xebialabs.xlrelease.domain.environments.Environment create​(com.xebialabs.xlrelease.domain.environments.Environment environment)
      Creates a new environment.
      com.xebialabs.xlrelease.api.v1.views.EnvironmentView createEnvironment​(com.xebialabs.xlrelease.api.v1.form.EnvironmentForm environmentForm)  
      void delete​(java.lang.String environmentId)
      Deletes an environment.
      com.xebialabs.xlrelease.domain.environments.Environment getById​(java.lang.String environmentId)
      Gets an environment by id.
      java.util.List<com.xebialabs.xlrelease.domain.environments.Application> getDeployableApplications​(java.lang.String environmentId)
      Gets all applications that are allowed to be deployed for a given environment
      java.util.List<com.xebialabs.xlrelease.api.v1.views.BaseApplicationView> getDeployableApplicationsForEnvironment​(java.lang.String environmentId)  
      com.xebialabs.xlrelease.api.v1.views.EnvironmentView getEnvironment​(java.lang.String environmentId)  
      java.util.List<com.xebialabs.xlrelease.domain.environments.EnvironmentReservation> getReservations​(java.lang.String environmentId)
      Gets all environment reservations for a given environment.
      java.util.List<com.xebialabs.xlrelease.api.v1.views.EnvironmentReservationView> getReservationsForEnvironment​(java.lang.String environmentId)  
      java.util.List<com.xebialabs.xlrelease.domain.environments.Environment> search​(com.xebialabs.xlrelease.api.v1.filter.EnvironmentFilters filters)
      Searches environments by filters.
      java.util.List<com.xebialabs.xlrelease.api.v1.views.EnvironmentView> searchEnvironments​(com.xebialabs.xlrelease.api.v1.filter.EnvironmentFilters environmentFilters)  
      default java.lang.String serviceName()  
      com.xebialabs.xlrelease.domain.environments.Environment update​(com.xebialabs.xlrelease.domain.environments.Environment environment)
      Updates an existing environment.
      com.xebialabs.xlrelease.api.v1.views.EnvironmentView updateEnvironment​(java.lang.String environmentId, com.xebialabs.xlrelease.api.v1.form.EnvironmentForm environmentForm)  

    • Method Detail

      • serviceName

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

      • createEnvironment

        @POST
com.xebialabs.xlrelease.api.v1.views.EnvironmentView createEnvironment​(com.xebialabs.xlrelease.api.v1.form.EnvironmentForm environmentForm)

      • getEnvironment

        @GET
@Path("/{environmentId:.*/Environment[^/]*}")
com.xebialabs.xlrelease.api.v1.views.EnvironmentView getEnvironment​(@PathParam("environmentId")
                                                                    java.lang.String environmentId)

      • updateEnvironment

        @PUT
@Path("/{environmentId:.*/Environment[^/]*}")
com.xebialabs.xlrelease.api.v1.views.EnvironmentView updateEnvironment​(@PathParam("environmentId")
                                                                       java.lang.String environmentId,
                                                                       com.xebialabs.xlrelease.api.v1.form.EnvironmentForm environmentForm)

      • searchEnvironments

        @POST
@Path("/search")
java.util.List<com.xebialabs.xlrelease.api.v1.views.EnvironmentView> searchEnvironments​(com.xebialabs.xlrelease.api.v1.filter.EnvironmentFilters environmentFilters)

      • getReservationsForEnvironment

        @GET
@Path("/{environmentId:.*/Environment[^/]*}/reservations")
java.util.List<com.xebialabs.xlrelease.api.v1.views.EnvironmentReservationView> getReservationsForEnvironment​(@PathParam("environmentId")
                                                                                                              java.lang.String environmentId)

      • getDeployableApplicationsForEnvironment

        @GET
@Path("/{environmentId:.*/Environment[^/]*}/applications")
java.util.List<com.xebialabs.xlrelease.api.v1.views.BaseApplicationView> getDeployableApplicationsForEnvironment​(@PathParam("environmentId")
                                                                                                                 java.lang.String environmentId)

      • delete

        @DELETE
@Path("/{environmentId:.*/Environment[^/]*}")
void delete​(@PathParam("environmentId")
            java.lang.String environmentId)
        Deletes an environment.
        Parameters:
        environmentId - the environment identifier

      • create

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

      • getById

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

      • update

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

      • search

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

      • getReservations

        java.util.List<com.xebialabs.xlrelease.domain.environments.EnvironmentReservation> getReservations​(java.lang.String environmentId)
        Gets all environment reservations for a given environment.
        Parameters:
        environmentId - the environment identifier
        Returns:
        list of matching EnvironmentReservations

      • getDeployableApplications

        java.util.List<com.xebialabs.xlrelease.domain.environments.Application> getDeployableApplications​(java.lang.String environmentId)
        Gets all applications that are allowed to be deployed for a given environment
        Parameters:
        environmentId - the environment identifier
        Returns:
        list of matching Applications