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
java.util.stream.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, java.util.List<java.lang.String> states, java.util.List<java.lang.String> users, java.lang.String taskName, java.lang.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, java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order, java.lang.String workerName, java.util.List<java.lang.String> targets)	Find all active Control Tasks, optionally filtered by parameters.
java.util.stream.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, java.util.List<java.lang.String> states, java.util.List<java.lang.String> users, java.util.List<java.lang.String> taskTypes, java.lang.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, java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order, java.lang.String workerName, java.util.List<com.xebialabs.deployit.engine.api.dto.ConfigurationItemId> configurationItemIds)	Find all active Deployment Tasks, optionally filtered by parameters.

Method Detail

getControlTasks

@POST
@Path("control")
java.util.stream.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")
                                                                                                   java.util.List<java.lang.String> states,
                                                                                                   @QueryParam("users")
                                                                                                   java.util.List<java.lang.String> users,
                                                                                                   @QueryParam("taskName")
                                                                                                   java.lang.String taskName,
                                                                                                   @QueryParam("taskId")
                                                                                                   java.lang.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")
                                                                                                   java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                                                   @QueryParam("worker")
                                                                                                   java.lang.String workerName,
                                                                                                   java.util.List<java.lang.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")
java.util.stream.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")
                                                                                                      java.util.List<java.lang.String> states,
                                                                                                      @QueryParam("users")
                                                                                                      java.util.List<java.lang.String> users,
                                                                                                      @QueryParam("types")
                                                                                                      java.util.List<java.lang.String> taskTypes,
                                                                                                      @QueryParam("taskId")
                                                                                                      java.lang.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")
                                                                                                      java.util.List<com.xebialabs.deployit.engine.api.dto.Ordering> order,
                                                                                                      @QueryParam("worker")
                                                                                                      java.lang.String workerName,
                                                                                                      java.util.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