TriggerRun
type: "io.kestra.plugin.dbt.cloud.TriggerRun"
Trigger 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.
Examples
id: "trigger_run"
type: "io.kestra.plugin.dbt.cloud.TriggerRun"
accountId: "<your-account>"
token: "<your token>"
jobId: "<your job id>"
Properties
accountId
- Type: string
- Dynamic: ✔️
- Required: ✔️
Numeric ID of the account
cause
- Type: string
- Dynamic: ✔️
- Required: ✔️
- Default:
Triggered by Kestra
A text description of the reason for running this job
jobId
- Type: string
- Dynamic: ✔️
- Required: ✔️
Numeric ID of the job
token
- Type: string
- Dynamic: ✔️
- Required: ✔️
API key.
dbtVersionOverride
- Type: string
- Dynamic: ✔️
- Required: ❌
Override the version of dbt used to run this job.
generateDocsOverride
- Type: boolean
- Dynamic: ❌
- Required: ❌
Override whether or not this job generates docs.
gitBranch
- Type: string
- Dynamic: ✔️
- Required: ❌
The git branch to check out before running this job
gitSha
- Type: string
- Dynamic: ✔️
- Required: ❌
The git sha to check out before running this job
maxDuration
- Type: string
- Dynamic: ❌
- Required: ❌
- Default:
3600.000000000
- Format:
duration
The max total wait duration
parseRunResults
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Parse run result
Parsing run result to display duration of each task inside dbt
pollFrequency
- Type: string
- Dynamic: ❌
- Required: ❌
- Default:
5.000000000
- Format:
duration
Specify frequency for job state check API calls
schemaOverride
- Type: string
- Dynamic: ✔️
- Required: ❌
Override the destination schema in the configured target for this job.
stepsOverride
- Type: array
- SubType: string
- Dynamic: ✔️
- Required: ❌
Override the list of steps for this job.
targetNameOverride
- Type: string
- Dynamic: ✔️
- Required: ❌
Override the target.name context variable used when running this job.
threadsOverride
- Type: string
- Dynamic: ✔️
- Required: ❌
Override the number of threads used to run this job.
timeoutSecondsOverride
- Type: integer
- Dynamic: ❌
- Required: ❌
Override the timeout in seconds for this job.
wait
- Type: boolean
- Dynamic: ❌
- Required: ❌
- Default:
true
Wait for the end of the run.
Allowing to capture job status & logs
Outputs
manifest
- Type: string
URI of a manifest
runId
- Type: integer
The run id.
runResults
- Type: string
URI of a run results