Skip to main content

revoke

Revoke task by task id (or list of ids).

def revoke(
state: object,
task_id: string|list,
terminate: boolean = False,
signal: string = null
) - > object

Revoke task by task id (or list of ids).

Parameters

NameTypeDescription
stateobjectThe current state object of the control command execution environment.
task_id`stringlist`
terminateboolean = FalseIf true, also terminate the worker process if the task is currently active.
signalstring = nullThe name of the specific signal to send for termination, such as 'KILL' or 'TERM'.

Returns

TypeDescription
objectA dictionary containing the status of the operation, typically indicating the tasks have been flagged as revoked.