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 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(String environmentId)
    Deletes an environment.
    com.xebialabs.xlrelease.domain.environments.Environment
    getById(String environmentId)
    Gets an environment by id.
    List<com.xebialabs.xlrelease.domain.environments.Application>
    getDeployableApplications(String environmentId)
    Gets all applications that are allowed to be deployed for a given environment
    List<com.xebialabs.xlrelease.api.v1.views.BaseApplicationView>
    getDeployableApplicationsForEnvironment(String environmentId)
     
    com.xebialabs.xlrelease.api.v1.views.EnvironmentView
    getEnvironment(String environmentId)
     
    List<com.xebialabs.xlrelease.domain.environments.EnvironmentReservation>
    getReservations(String environmentId)
    Gets all environment reservations for a given environment.
    List<com.xebialabs.xlrelease.api.v1.views.EnvironmentReservationView>
    getReservationsForEnvironment(String environmentId)
     
    List<com.xebialabs.xlrelease.domain.environments.Environment>
    search(com.xebialabs.xlrelease.api.v1.filter.EnvironmentFilters filters)
    Searches environments by filters.
    List<com.xebialabs.xlrelease.api.v1.views.EnvironmentView>
    searchEnvironments(com.xebialabs.xlrelease.api.v1.filter.EnvironmentFilters environmentFilters)
     
    default 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(String environmentId, com.xebialabs.xlrelease.api.v1.form.EnvironmentForm environmentForm)
     

  • Method Details

    • serviceName

      default 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") String environmentId)

    • updateEnvironment

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

    • searchEnvironments

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

    • getReservationsForEnvironment

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

    • getDeployableApplicationsForEnvironment

      @GET @Path("/{environmentId:.*/Environment[^/]*}/applications") List<com.xebialabs.xlrelease.api.v1.views.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

      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(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

      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

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

    • getDeployableApplications

      List<com.xebialabs.xlrelease.domain.environments.Application> getDeployableApplications(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