TriggerRun
Trigger a dbt cloud job to run.
Use this task to kick off a run for a job. When this endpoint returns a successful response, a new run will be enqueued for the account. If you activate the wait
option, it will wait for the job to be ended and will display all the log and dynamic tasks.
type: "io.kestra.plugin.dbt.cloud.TriggerRun"
Examples
id: dbt_trigger_job_run
namespace: company.team
tasks:
- id: trigger_run
type: io.kestra.plugin.dbt.cloud.TriggerRun
accountId: "dbt_account"
token: "dbt_token"
jobId: "job_id"
Properties
accountId *Requiredstring
Numeric ID of the account.
jobId *Requiredstring
Numeric ID of the job.
token *Requiredstring
API key.
baseUrl string
https://cloud.getdbt.com
Base URL to select the tenant.
cause string
Triggered by Kestra.
A text description of the reason for running this job.
dbtVersionOverride string
Override the version of dbt used to run this job.
generateDocsOverride booleanstring
Override whether or not this job generates docs.
gitBranch string
The git branch to check out before running this job.
gitSha string
The git SHA to check out before running this job.
initialDelayMs integerstring
1000
Initial delay in milliseconds before retrying
Default: 1000 ms (1 second)
maxDuration string
PT1H
duration
The maximum total wait duration.
maxRetries integerstring
3
Maximum number of retries in case of transient errors
Default: 3
options Non-dynamicHttpConfiguration
The HTTP client configuration.
parseRunResults booleanstring
true
Parse run result.
Parsing run result to display duration of each task inside dbt.
pollFrequency string
PT5S
duration
Specify frequency for job state check API calls.
schemaOverride string
Override the destination schema in the configured target for this job.
stepsOverride array
Override the list of steps for this job.
targetNameOverride string
Override the target.name context variable used when running this job.
threadsOverride string
Override the number of threads used to run this job.
timeoutSecondsOverride integerstring
Override the timeout in seconds for this job.
wait booleanstring
true
Wait for the end of the run.
Allowing to capture job status & logs.
Outputs
manifest string
uri
URI of a manifest.
runId integer
The run ID.
runResults string
uri
URI of a run result.
Definitions
io.kestra.core.http.client.configurations.TimeoutConfiguration
connectTimeout string
duration
The time allowed to establish a connection to the server before failing.
readIdleTimeout string
PT5M
duration
The time allowed for a read connection to remain idle before closing it.
io.kestra.core.http.client.configurations.BasicAuthConfiguration
type *Requiredobject
password string
The password for HTTP basic authentication.
username string
The username for HTTP basic authentication.
java.nio.charset.Charset
io.kestra.core.http.client.configurations.HttpConfiguration
allowFailed booleanstring
false
If true, allow a failed response code (response code >= 400)
allowedResponseCodes array
List of response code allowed for this request
auth BasicAuthConfigurationBearerAuthConfiguration
The authentification to use.
defaultCharset Charsetstring
UTF-8
The default charset for the request.
followRedirects booleanstring
true
Whether redirects should be followed automatically.
logs array
REQUEST_HEADERS
REQUEST_BODY
RESPONSE_HEADERS
RESPONSE_BODY
The enabled log.
proxy ProxyConfiguration
The proxy configuration.
ssl SslOptions
The SSL request options
timeout TimeoutConfiguration
The timeout configuration.
io.kestra.core.http.client.configurations.ProxyConfiguration
address string
The address of the proxy server.
password string
The password for proxy authentication.
port integerstring
The port of the proxy server.
type string
DIRECT
DIRECT
HTTP
SOCKS
The type of proxy to use.
username string
The username for proxy authentication.
io.kestra.core.http.client.configurations.SslOptions
insecureTrustAllCertificates booleanstring
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.
io.kestra.core.http.client.configurations.BearerAuthConfiguration
type *Requiredobject
token string
The token for bearer token authentication.