Delete a pipeline by ID

Deletes a pipeline by its ID within a project with comprehensive cleanup options. This operation can be performed synchronously or asynchronously depending on the cleanup operations required.

Process Overview:

• Validation Phase: Validates project and pipeline existence, association, and user permissions
• Pipeline State Check: Determines if pipeline is currently running
• Graceful Shutdown (if pipeline is running):
  • Stops the pipeline execution
  • Disables data capture (if disableCapture is true)
  • Clears pending backlog (if clearBacklog is true)
  • Stops associated log reader processes (if stopLogReader is true)
• Configuration Cleanup: Removes pipeline configuration and associated resources

Execution Modes:

• Synchronous: For simple pipeline deletions (stopping and deleting without cleanup operations)
• Asynchronous: For complex deletions requiring extensive cleanup operations (e.g., disabling capture, clearing backlog, stopping log readers)

Pre-deletion Operations:

• Disable Capture: Stops data replication while preserving existing data
• Clear Backlog: Removes pending data changes that haven't been processed
• Stop Log Reader: Gracefully shuts down log reading processes

Key Considerations:

• Running pipelines are automatically stopped before deletion
• Monitor deletion progress using the endpoint returned in the Location header for 202 responses

Required Permissions: replication-pipeline::delete when permission harmonization is enabled; otherwise, replication-pipeline::manage.