Early Access: The content on this website is provided for informational purposes only in connection with pre-General Availability Qlik Products.
All content is subject to change and is provided without warranty.
Skip to main content Skip to complementary content
Qlik Resources

StopTask

Stop the selected task.

Required User Role: See Required Enterprise Manager permissions.

Syntax

public AemStopTaskResp StopTask(

string server,

string task,

int timeout = 30

);

Parameters

Parameters
Parameter Type Description
server string The name of the server.

task

string
  • Replicate: - The name of the task.

  • Compose: - The name of the task or workflow appended with a double underscore and the project name.

    Example:  

    mytask__myproject

timeout

int

Time in seconds to wait until getting a response.

Return values

AemStopTaskResp

Return values
Parameter Type Description

State

AemTaskState

{

STOPPED = 0,

RUNNING = 1,

ERROR = 2,

RECOVERY = 3

}

The current state of the task.
ErrorMessage string The description of the error.

Errors

Error responses
Error Message Description

AEM_TASK_ALREADY_STOPPED

Replicate task {task} on server {server} is already stopped.

Cannot stop a task that is in Stopped state.

AEM_STOP_TASK_INNER_ERR

Failed to stop Replicate task {0} on server {1}: <{2}>

An error occurred while trying to stop the task.

AEM_STOP_TASK_TIMEOUT

A timeout occurred when trying to stop Replicate task {0} on server {1}

A timeout occurred while trying to stop the task.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!

Leave your feedback here