Package com.xebialabs.deployit.core.api

Interface TaskMonitorService

@Path("/taskmonitor") @Consumes({"application/xml","application/json"}) @Produces({"application/xml","application/json"}) public interface TaskMonitorService

  • Method Summary

    Modifier and Type
    Method
    Description
    Stream<com.xebialabs.deployit.engine.api.execution.TaskWithBlock>
    getControlTasks(com.xebialabs.deployit.core.api.resteasy.Date begin, com.xebialabs.deployit.core.api.resteasy.Date end, List<String> states, List<String> users, String taskName, String taskId, com.xebialabs.deployit.engine.api.execution.FetchMode fetchMode, com.xebialabs.deployit.engine.api.execution.TaskSet taskSet, com.xebialabs.deployit.engine.api.dto.Paging paging, List<com.xebialabs.deployit.engine.api.dto.Ordering> order, String workerName, List<String> targets)
    Find all active Control Tasks, optionally filtered by parameters.
    Stream<com.xebialabs.deployit.engine.api.execution.TaskWithBlock>
    getDeploymentTasks(com.xebialabs.deployit.core.api.resteasy.Date begin, com.xebialabs.deployit.core.api.resteasy.Date end, List<String> states, List<String> users, List<String> taskTypes, String taskId, com.xebialabs.deployit.engine.api.execution.FetchMode fetchMode, com.xebialabs.deployit.engine.api.execution.TaskSet taskSet, boolean onlySuccessful, com.xebialabs.deployit.engine.api.dto.Paging paging, List<com.xebialabs.deployit.engine.api.dto.Ordering> order, String workerName, List<com.xebialabs.deployit.engine.api.dto.ConfigurationItemId> configurationItemIds)
    Find all active Deployment Tasks, optionally filtered by parameters.

  • Method Details

    • getControlTasks

      @POST @Path("control") Stream<com.xebialabs.deployit.engine.api.execution.TaskWithBlock> getControlTasks(@QueryParam("begin") com.xebialabs.deployit.core.api.resteasy.Date begin, @QueryParam("end") com.xebialabs.deployit.core.api.resteasy.Date end, @QueryParam("states") List<String> states, @QueryParam("users") List<String> users, @QueryParam("taskName") String taskName, @QueryParam("taskId") String taskId, @QueryParam("fetchMode") com.xebialabs.deployit.engine.api.execution.FetchMode fetchMode, @QueryParam("taskSet") com.xebialabs.deployit.engine.api.execution.TaskSet taskSet, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") List<com.xebialabs.deployit.engine.api.dto.Ordering> order, @QueryParam("worker") String workerName, List<String> targets)
      Find all active Control Tasks, optionally filtered by parameters.
      Parameters:
      begin - filter by time interval beginning with date
      end - filter by time interval ending with date
      states - (Optional) filter task by task state
      users - (Optional) filter tasks belonging to users
      taskName - (Optional) filter by name of the task
      taskId - (Optional) filter task with exact taskId
      fetchMode - (Optional) toggle to fetch FULL task with blocks or just task SUMMARY
      taskSet - filter by taskSet - MY or ALL
      paging - (Optional) Which page and how many results per page to retrieve
      order - (Optional) Which ordering to use when listing results
      workerName - (Optional) filter only specified workers
      targets - filter by selected target CI
      Returns:
      list of TaskWithBlock

    • getDeploymentTasks

      @POST @Path("deployment") Stream<com.xebialabs.deployit.engine.api.execution.TaskWithBlock> getDeploymentTasks(@QueryParam("begin") com.xebialabs.deployit.core.api.resteasy.Date begin, @QueryParam("end") com.xebialabs.deployit.core.api.resteasy.Date end, @QueryParam("states") List<String> states, @QueryParam("users") List<String> users, @QueryParam("types") List<String> taskTypes, @QueryParam("taskId") String taskId, @QueryParam("fetchMode") com.xebialabs.deployit.engine.api.execution.FetchMode fetchMode, @QueryParam("taskSet") com.xebialabs.deployit.engine.api.execution.TaskSet taskSet, @QueryParam("onlySuccessful") boolean onlySuccessful, @BeanParam com.xebialabs.deployit.engine.api.dto.Paging paging, @QueryParam("order") List<com.xebialabs.deployit.engine.api.dto.Ordering> order, @QueryParam("worker") String workerName, List<com.xebialabs.deployit.engine.api.dto.ConfigurationItemId> configurationItemIds)
      Find all active Deployment Tasks, optionally filtered by parameters.
      Parameters:
      begin - filter by time interval beginning with date
      end - filter by time interval ending with date
      states - (Optional) filter task by task state
      users - (Optional) filter tasks belonging to users
      taskTypes - (Optional) filter by task type - DEFAULT, INITIAL, ROLLBACK, UNDEPLOY, UPGRADE
      taskId - (Optional) filter task with exact taskId
      fetchMode - (Optional) toggle to fetch FULL task with blocks or just task SUMMARY
      taskSet - filter by taskSet - MY or ALL
      onlySuccessful - Deprecated use states instead
      paging - (Optional) Which page and how many results per page to retrieve
      order - (Optional) Which ordering to use when listing results
      workerName - (Optional) filter only specified workers
      configurationItemIds - filter by list of CIs - environment and application correlated to the Deployment task
      Returns:
      list of TaskWithBlock