DeleteTask Method

Overview

The deleteTask method terminates and cleans up a running task. This method is essential for resource management, stopping long-running tasks, and cleaning up completed tasks to free up system resources.

Method Signature

Parameters

None – uses the task token and type stored in the client instance from a previous startTask() call.

Returns

• Type: Promise<object>
• Description: API response confirming task deletion

Throws

• Error: If no task is running or network error occurs

Prerequisites

Usage Examples

Basic Task Deletion

const AparaviDTC = require('aparavi-dtc-node-sdk');

const client = new AparaviDTC('your-api-key');

async function deleteBasicTask() {
  try {
    // First start a task
    const pipeline = {
      pipeline: {
        components: [
          {
            name: 'source',
            provider: 'file',
            config: { path: '/data/source' }
          }
        ]
      }
    };
    
    await client.startTask(pipeline);
    console.log('Task started with token:', client.token);
    
    // Now delete the task
    const result = await client.deleteTask();
    console.log('Task deleted successfully:', result);
    
  } catch (error) {
    console.error('Error deleting task:', error.message);
  }
}

deleteBasicTask();

Response Format

Successful Task Deletion

{
  data: {
    id: 'task_1234567890abcdef',
    status: 'deleted',
    deleted_at: '2024-01-15T10:45:00Z',
    message: 'Task deleted successfully'
  },
  message: 'Task deletion completed'
}

Failed Task Deletion

{
  error: 'Task not found',
  message: 'The specified task does not exist or has already been deleted'
}

Error Handling

Common Task Deletion Errors

No Active Task

Task Not Found

Task Already Completed

Authentication Errors

Performance Considerations

• Immediate Deletion: Deleting tasks immediately frees up resources
• Batch Deletion: Consider deleting multiple tasks in sequence
• Rate Limiting: Be mindful of API rate limits when deleting many tasks
• Resource Cleanup: Always clean up tasks to prevent resource leaks

Security Notes

• API Key: Your API key is sent with each request
• HTTPS: All requests use HTTPS encryption
• Access Control: Only the task creator can delete their tasks
• Audit Trail: Consider keeping completed tasks for audit purposes

Related Methods

• startTask() – Start a task before deleting
• getTask() – Check task status before deletion
• tearDown() – Reset client state after deletion

API Endpoint

Next Steps