Sync

type: "io.kestra.plugin.airbyte.connections.Sync"

Run a sync on a connection.

Examples

id: airbyte_sync
namespace: company.team

tasks:
  - id: sync
    type: io.kestra.plugin.airbyte.connections.Sync
    url: http://localhost:8080
    connectionId: e3b1ce92-547c-436f-b1e8-23b6936c12cd

Properties

url

• Type: string
• Dynamic: ✔️
• Required: ✔️

The URL of your Airbyte instance.

connectionId

• Type: string
• Dynamic: ✔️
• Required: ❌

The connection ID to sync.

failOnActiveSync

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: true

Specify whether task should fail if a sync is already running.

httpTimeout

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: 10.000000000
• Format: duration

HTTP connection timeout.

maxDuration

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: 3600.000000000
• Format: duration

The maximum total wait duration.

password

• Type: string
• Dynamic: ✔️
• Required: ❌

Basic authentication password.

pollFrequency

• Type: string
• Dynamic: ❌
• Required: ❌
• Default: 1.000000000
• Format: duration

Specify frequency for sync attempt state check API call.

token

• Type: string
• Dynamic: ✔️
• Required: ❌

API key.

username

• Type: string
• Dynamic: ✔️
• Required: ❌

Basic authentication username.

wait

• Type: boolean
• Dynamic: ❌
• Required: ❌
• Default: true

Wait for the job to end.

Allowing capture of job status & logs.

Outputs

alreadyRunning

• Type: boolean
• Required: ❌

Whether a sync was already running.

jobId

• Type: integer
• Required: ❌

The job ID created.

Definitions