com.xebialabs.deployit.cli.api

Class TaskClient

java.lang.Object

com.xebialabs.deployit.cli.api.DocumentedObject

com.xebialabs.deployit.cli.api.TaskClient

@CliObject(name="tasks")
public class TaskClient
extends DocumentedObject

Exposes the TaskService.

Since:

Deployit 3.8

Constructor Summary

Constructors

Constructor and Description
TaskClient()
TaskClient(ProxiesInstance proxies)

Method Summary

Methods

Modifier and Type	Method and Description
void	abort(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	addPause(java.lang.String taskId, int stepId)
void	archive(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.TaskState	assign(java.lang.String taskId, java.lang.String owner)
void	cancel(java.lang.String taskId)
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskWithSteps>	export(java.lang.String begin, java.lang.String end)
com.xebialabs.deployit.engine.api.execution.TaskState	get(java.lang.String taskId)
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState>	getAllCurrentTasks()
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState>	getMyCurrentTasks()
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	moveStep(java.lang.String taskId, int stepId, int newPosition)
java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState>	query(java.lang.String begin, java.lang.String end)
void	schedule(java.lang.String taskId, org.joda.time.DateTime dateTime)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	skip(java.lang.String taskId, java.util.List<java.lang.Integer> stepIds)
void	start(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.StepState	step(java.lang.String taskId, int stepId)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	steps(java.lang.String taskId)
void	stop(java.lang.String taskId)
com.xebialabs.deployit.engine.api.execution.TaskState	takeover(java.lang.String taskId, java.lang.String currentOwner)
com.xebialabs.deployit.engine.api.execution.TaskWithSteps	unskip(java.lang.String taskId, java.util.List<java.lang.Integer> stepIds)

Methods inherited from class com.xebialabs.deployit.cli.api.DocumentedObject

help, help

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TaskClient

public TaskClient()

TaskClient

public TaskClient(ProxiesInstance proxies)

Method Detail

getMyCurrentTasks

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState> getMyCurrentTasks()

getAllCurrentTasks

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState> getAllCurrentTasks()

get

public com.xebialabs.deployit.engine.api.execution.TaskState get(java.lang.String taskId)

steps

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps steps(java.lang.String taskId)

step

public com.xebialabs.deployit.engine.api.execution.StepState step(java.lang.String taskId,
                                                         int stepId)

start

public void start(java.lang.String taskId)

schedule

public void schedule(java.lang.String taskId,
            org.joda.time.DateTime dateTime)

stop

public void stop(java.lang.String taskId)

abort

public void abort(java.lang.String taskId)

cancel

public void cancel(java.lang.String taskId)

archive

public void archive(java.lang.String taskId)

skip

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps skip(java.lang.String taskId,
                                                             java.util.List<java.lang.Integer> stepIds)

unskip

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps unskip(java.lang.String taskId,
                                                               java.util.List<java.lang.Integer> stepIds)

addPause

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps addPause(java.lang.String taskId,
                                                                 int stepId)

moveStep

public com.xebialabs.deployit.engine.api.execution.TaskWithSteps moveStep(java.lang.String taskId,
                                                                 int stepId,
                                                                 int newPosition)

assign

public com.xebialabs.deployit.engine.api.execution.TaskState assign(java.lang.String taskId,
                                                           java.lang.String owner)

takeover

public com.xebialabs.deployit.engine.api.execution.TaskState takeover(java.lang.String taskId,
                                                             java.lang.String currentOwner)

query

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskState> query(java.lang.String begin,
                                                                          java.lang.String end)

export

public java.util.List<com.xebialabs.deployit.engine.api.execution.TaskWithSteps> export(java.lang.String begin,
                                                                               java.lang.String end)