Skip to main content

TaskManager

@nuclia/core

@nuclia/core / TaskManager

Class: TaskManager

Defined in: libs/sdk-core/src/lib/db/task/task.ts:13

Constructors​

Constructor​

new TaskManager(kb, nuclia): TaskManager

Defined in: libs/sdk-core/src/lib/db/task/task.ts:17

Parameters​

kb​

WritableKnowledgeBox

nuclia​

INuclia

Returns​

TaskManager

Properties​

kb​

kb: WritableKnowledgeBox

Defined in: libs/sdk-core/src/lib/db/task/task.ts:14

nuclia​

nuclia: INuclia

Defined in: libs/sdk-core/src/lib/db/task/task.ts:15

Methods​

cleanTask()​

cleanTask(taskId): Observable<void>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:81

Remove the data generated by a task

Parameters​

taskId​

string

Returns​

Observable<void>

deleteTask()​

deleteTask(taskId, clean?): Observable<void>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:38

Delete a task so it is not listed anymore in getTasks. If the task is currently running, you should stop it before deleting it.

Parameters​

taskId​

string

clean?​

boolean = false

Returns​

Observable<void>

editTask()​

editTask(taskId, parameters): Observable<unknown>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:99

Edit a tasks

Parameters​

taskId​

string

parameters​

TaskParameters

Parameters configuring the task

Returns​

Observable<unknown>

enableTask()​

enableTask(taskId, enabled): Observable<unknown>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:107

Enable or disable a tasks

Parameters​

taskId​

string

enabled​

boolean

Returns​

Observable<unknown>

getTask()​

getTask(taskId): Observable<InspectTaskResponse>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:90

Get the status of a tasks

Parameters​

taskId​

string

Returns​

Observable<InspectTaskResponse>

getTasks()​

getTasks(count?): Observable<TaskListResponse>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:27

List the available tasks on a KB and get the list of tasks running and done.

Parameters​

count?​

number

How many finished task to return. By default, the server is returning 10.

Returns​

Observable<TaskListResponse>

restartTask()​

restartTask(taskId): Observable<StartStopTaskResponse>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:73

Restart a running task.

Parameters​

taskId​

string

Returns​

Observable<StartStopTaskResponse>

startTask()​

startTask(name, parameters?, apply?, enabled?, uuid_task?): Observable<StartStopTaskResponse>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:51

Start a new task

Parameters​

name​

TaskName

Name of the task

parameters?​

TaskParameters

Parameters configuring the task

apply?​

ApplyOption = 'EXISTING'

Apply the task to:

  • EXISTING: only the resources already existing in the KB.
  • NEW: only the resources created in the KB after the task is started
  • ALL: all the existing and new resources of the KB
enabled?​

boolean

uuid_task?​

string

Returns​

Observable<StartStopTaskResponse>

stopTask()​

stopTask(taskId): Observable<StartStopTaskResponse>

Defined in: libs/sdk-core/src/lib/db/task/task.ts:65

Stop a running task.

Parameters​

taskId​

string

Returns​

Observable<StartStopTaskResponse>