DeleteTask interface
Methods
| delete(Delete |
When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background. |
| get(Get |
For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks. |
| put(Replace |
Updates the properties of the specified Task. |
Method Details
delete(DeleteTaskParameters)
When a Task is deleted, all of the files in its directory on the Compute Node where it ran are also deleted (regardless of the retention time). For multi-instance Tasks, the delete Task operation applies synchronously to the primary task; subtasks and their files are then deleted asynchronously in the background.
function delete(options?: DeleteTaskParameters): StreamableMethod<DeleteTask200Response | DeleteTaskDefaultResponse>Parameters
- options
- DeleteTaskParameters
Returns
get(GetTaskParameters)
For multi-instance Tasks, information such as affinityId, executionInfo and nodeInfo refer to the primary Task. Use the list subtasks API to retrieve information about subtasks.
function get(options?: GetTaskParameters): StreamableMethod<GetTask200Response | GetTaskDefaultResponse>Parameters
- options
- GetTaskParameters
Returns
put(ReplaceTaskParameters)
Updates the properties of the specified Task.
function put(options: ReplaceTaskParameters): StreamableMethod<ReplaceTask200Response | ReplaceTaskDefaultResponse>Parameters
- options
- ReplaceTaskParameters
