Interface EnvironmentApi

  • All Superinterfaces:
    ApiService

    @Path("/api/v1/environments")
    @Consumes("application/json")
    @Produces("application/json")
    public interface EnvironmentApi
    extends ApiService
    • Method Detail

      • serviceName

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

        @GET
        @Path("/{environmentId:.*/Environment[^/]*}")
        EnvironmentView getEnvironment​(@PathParam("environmentId")
                                       java.lang.String environmentId)
      • updateEnvironment

        @PUT
        @Path("/{environmentId:.*/Environment[^/]*}")
        EnvironmentView updateEnvironment​(@PathParam("environmentId")
                                          java.lang.String environmentId,
                                          EnvironmentForm environmentForm)
      • getReservationsForEnvironment

        @GET
        @Path("/{environmentId:.*/Environment[^/]*}/reservations")
        java.util.List<EnvironmentReservationView> getReservationsForEnvironment​(@PathParam("environmentId")
                                                                                 java.lang.String environmentId)
      • getDeployableApplicationsForEnvironment

        @GET
        @Path("/{environmentId:.*/Environment[^/]*}/applications")
        java.util.List<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

        Environment create​(Environment environment)
        Creates a new environment.
        Parameters:
        environment - an Environment object describing the new environment
        Returns:
        created Environment object
      • getById

        Environment getById​(java.lang.String environmentId)
        Gets an environment by id.
        Parameters:
        environmentId - the environment identifier
        Returns:
        found Environment object
      • update

        Environment update​(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<Environment> search​(EnvironmentFilters filters)
        Searches environments by filters.
        Parameters:
        filters - an EnvironmentFilters object describing the search criteria
        Returns:
        list of matching Environments
      • getReservations

        java.util.List<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<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