
Airbyte CheckStatus
CertifiedWait for an Airbyte job
Airbyte CheckStatus
Wait for an Airbyte job
Polls Airbyte until a job reaches a terminal state, streams attempt logs, and emits sync metrics. Polling runs every second for up to 60 minutes unless you change pollFrequency or maxDuration
type: io.kestra.plugin.airbyte.connections.CheckStatusExamples
id: airbyte_check_status
namespace: company.team
tasks:
- id: check_status
type: io.kestra.plugin.airbyte.connections.CheckStatus
url: http://localhost:8080
jobId: "970"
Properties
jobId *Requiredstring
Job ID
Airbyte job ID to monitor.
url *Requiredstring
Airbyte API URL
Base URL of the Airbyte instance to call. This value is rendered from the current run context
applicationCredentials Non-dynamic
Application credentials
Client credentials used to request an Airbyte application access token from /api/v1/applications/token. Use this instead of a static token when Airbyte application authentication is enabled
io.kestra.plugin.airbyte.AbstractAirbyteConnection-ApplicationCredentials
Client ID
Airbyte application client ID
Client secret
Airbyte application client secret. Store this value in a Secret
maxDuration string
PT1HMaximum wait duration
Maximum total time to wait for the job to finish. Defaults to 60 minutes
options Non-dynamic
HTTP client options
HTTP client configuration applied to Airbyte API requests
io.kestra.core.http.client.configurations.HttpConfiguration
falseIf true, allow a failed response code (response code >= 400)
List of response code allowed for this request
The authentication to use.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
The password for HTTP basic authentication.
The username for HTTP basic authentication.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
The token for bearer token authentication.
io.kestra.core.http.client.configurations.DigestAuthConfiguration
The password for HTTP Digest authentication.
The username for HTTP Digest authentication.
The password for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
The username for HTTP basic authentication. Deprecated, use auth property with a BasicAuthConfiguration instance instead.
durationThe time allowed to establish a connection to the server before failing.
durationThe time an idle connection can remain in the client's connection pool before being closed.
UTF-8The default charset for the request.
java.nio.charset.Charset
trueWhether to enable TCP Keep-Alive extended socket options (TCP_KEEPIDLE, TCP_KEEPINTERVAL, TCP_KEEPCOUNT).
Set to false when running on Windows workers, as these extended socket options are not supported by the Windows JDK and will cause connection failures.
trueWhether redirects should be followed automatically.
ALLTRACEDEBUGINFOWARNERROROFFNOT_SPECIFIEDThe log level for the HTTP client.
REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODYThe enabled log.
The maximum content length of the response.
The proxy configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTDIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
The address of the proxy server.
The password for proxy authentication.
The port of the proxy server.
DIRECTHTTPSOCKSThe type of proxy to use.
The username for proxy authentication.
durationThe time allowed for a read connection to remain idle before closing it.
durationThe maximum time allowed for reading data from the server before failing.
The SSL request options
io.kestra.core.http.client.configurations.SslOptions
Whether to disable checking of the remote SSL certificate.
Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.
The timeout configuration.
io.kestra.core.http.client.configurations.TimeoutConfiguration
The time allowed to establish a connection to the server before failing.
PT5MThe time allowed for a read connection to remain idle before closing it.
password string
Basic auth password
Password for Airbyte basic authentication. Store this value in a Secret
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
pollFrequency string
PT1SPoll frequency
Interval between Airbyte job status checks. Defaults to 1 second
token string
Bearer token
Bearer token used for Airbyte API requests. This value is rendered from the current run context
username string
Basic auth username
Username for Airbyte basic authentication. If both basic auth and a bearer token are configured, basic auth is sent last and takes precedence
Outputs
finalJobStatus string
Final job status
Terminal Airbyte job status returned by the task
Metrics
attempts.count counter
attemptNumber of attempts made during the Airbyte sync
bytes.emitted counter
byteNumber of bytes emitted during processing
records.committed counter
recordNumber of records successfully committed
records.emitted counter
recordNumber of records emitted during processing
state.emitted counter
messageNumber of state messages emitted