StartTask Method

Overview

The startTask method initiates a new data transfer task using the provided pipeline configuration. This method validates the pipeline internally and creates a task that can be monitored and managed throughout its lifecycle.

Method Signature

Parameters

Returns

• Type: Promise<object>
• Description: API response containing task details including token and type

Throws

• Error: If task creation fails or network error occurs

Side Effects

Usage Examples

Basic Task Creation

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

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

async function startBasicTask() {
  const pipeline = {
    pipeline: {
      components: [
        {
          name: 'source',
          provider: 'file',
          config: { path: '/data/source' }
        },
        {
          name: 'destination',
          provider: 'webhook',
          config: { url: 'https://your-webhook.com/upload' }
        }
      ]
    }
  };

  try {
    const result = await client.startTask(pipeline);
    console.log('Task started successfully:', result.data);
    console.log('Task token:', client.token);
    console.log('Task type:', client.type);
  } catch (error) {
    console.error('Failed to start task:', error.message);
  }
}

startBasicTask();

Pipeline Configuration Structure

The pipelineJson parameter should follow this structure:

{
  pipeline: {
    components: [
      {
        name: string,           // Component name
        provider: string,       // Provider type
        config: object          // Provider-specific configuration
      }
    ]
  }
}

Supported Provider Types

File Provider

{
  name: 'source',
  provider: 'file',
  config: {
    path: '/path/to/files'
  }
}

Webhook Provider

{
  name: 'destination',
  provider: 'webhook',
  config: {
    url: 'https://your-webhook.com/endpoint'
  }
}

Database Provider

{
  name: 'database',
  provider: 'database',
  config: {
    connection: 'postgresql://user:pass@host:port/db',
    query: 'SELECT * FROM table'
  }
}

Response Format

Successful Task Creation

{
  data: {
    id: 'task_1234567890abcdef',
    token: 'tok_abcdef1234567890',
    type: 'data_transfer',
    status: 'created',
    created_at: '2024-01-15T10:30:00Z'
  },
  message: 'Task created successfully'
}

Failed Task Creation

{
  error: 'Invalid pipeline configuration',
  details: [
    {
      component: 'source',
      field: 'path',
      message: 'Path does not exist'
    }
  ]
}

Error Handling

Common Task Creation Errors

Invalid Pipeline Configuration

Authentication Errors

Resource Errors

Task Lifecycle

Task States

Performance Considerations

• Task Creation Time: Typically 2-5 seconds
• Resource Usage: Tasks consume API rate limits
• Concurrent Tasks: Limit concurrent task creation to avoid rate limiting
• Task Cleanup: Always clean up completed tasks to free resources

Security Notes

• API Key: Your API key is sent with each request
• HTTPS: All requests use HTTPS encryption
• Token Security: Task tokens are sensitive – don’t log them in production
• Resource Limits: Be mindful of API rate limits and resource quotas

Related Methods

• validate() – Validate pipeline before starting
• getTask() – Check task status
• deleteTask() – Clean up tasks
• sendToWebhook() – Upload files to webhook tasks

API Endpoint

Next Steps