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.

yaml
type: "io.kestra.plugin.dbt.cloud.TriggerRun"

Examples

yaml
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 *string

Numeric ID of the account.

jobId *string

Numeric ID of the job.

token *string

API key.

baseUrl string

Default https://cloud.getdbt.com

Base URL to select the tenant.

cause string

Default 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

Default 1000

Initial delay in milliseconds before retrying

Default: 1000 ms (1 second)

maxDuration string

Default PT1H

Format duration

The maximum total wait duration.

maxRetries integerstring

Default 3

Maximum number of retries in case of transient errors

Default: 3

options HttpConfiguration

The HTTP client configuration.

parseRunResults booleanstring

Default true

Parse run result.

Parsing run result to display duration of each task inside dbt.

pollFrequency string

Default PT5S

Format duration

Specify frequency for job state check API calls.

schemaOverride string

Override the destination schema in the configured target for this job.

stepsOverride array

SubType string

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

Default true

Wait for the end of the run.

Allowing to capture job status & logs.

Outputs

manifest string

Format uri

URI of a manifest.

runId integer

The run ID.

runResults string

Format uri

URI of a run result.

Definitions

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeout string

Format duration

The time allowed to establish a connection to the server before failing.

readIdleTimeout string

Default PT5M

Format duration

The time allowed for a read connection to remain idle before closing it.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type *object

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

Default false

If true, allow a failed response code (response code >= 400)

allowedResponseCodes array

SubType integer

List of response code allowed for this request

auth BasicAuthConfiguration BearerAuthConfiguration

The authentification to use.

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

followRedirects booleanstring

Default true

Whether redirects should be followed automatically.

logs array

SubType string

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_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

Default DIRECT

Possible Values

DIRECTHTTPSOCKS

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 *object

token string

The token for bearer token authentication.

​Trigger​Run

TriggerRun