TaskManager
@nuclia/core • Docs
@nuclia/core / TaskManager
Class: TaskManager
Constructors
new TaskManager()
new TaskManager(
kb,nuclia):TaskManager
Parameters
• kb: WritableKnowledgeBox
• nuclia: INuclia
Returns
Defined in
libs/sdk-core/src/lib/db/task/task.ts:17
Properties
kb
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>
Remove the data generated by a task
Parameters
• taskId: string
Returns
Observable<void>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:81
deleteTask()
deleteTask(
taskId,clean):Observable<void>
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>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:38
editTask()
editTask(
taskId,parameters):Observable<unknown>
Edit a tasks
Parameters
• taskId: string
• parameters: TaskParameters
Parameters configuring the task
Returns
Observable<unknown>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:99
enableTask()
enableTask(
taskId,enabled):Observable<unknown>
Enable or disable a tasks
Parameters
• taskId: string
• enabled: boolean
Returns
Observable<unknown>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:107
getTask()
getTask(
taskId):Observable<InspectTaskResponse>
Get the status of a tasks
Parameters
• taskId: string
Returns
Observable<InspectTaskResponse>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:90
getTasks()
getTasks(
count?):Observable<TaskListResponse>
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>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:27
restartTask()
restartTask(
taskId):Observable<StartStopTaskResponse>
Restart a running task.
Parameters
• taskId: string
Returns
Observable<StartStopTaskResponse>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:73
startTask()
startTask(
name,parameters?,apply?,enabled?,uuid_task?):Observable<StartStopTaskResponse>
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>
Defined in
libs/sdk-core/src/lib/db/task/task.ts:51
stopTask()
stopTask(
taskId):Observable<StartStopTaskResponse>
Stop a running task.
Parameters
• taskId: string
Returns
Observable<StartStopTaskResponse>