You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/data-sources/job.md
+81-15Lines changed: 81 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,12 @@
3
3
page_title: "dbtcloud_job Data Source - dbtcloud"
4
4
subcategory: ""
5
5
description: |-
6
-
6
+
Retrieve a job by ID
7
7
---
8
8
9
9
# dbtcloud_job (Data Source)
10
10
11
-
11
+
Retrieve a job by ID
12
12
13
13
14
14
@@ -17,29 +17,95 @@ description: |-
17
17
18
18
### Required
19
19
20
-
-`job_id` (Number) ID of the job
21
-
-`project_id` (Number) ID of the project the job is in
20
+
-`job_id` (Number) The ID of the job
21
+
22
+
### Optional
23
+
24
+
-`environment` (Attributes) Details of the environment the job is running in (see [below for nested schema](#nestedatt--environment))
25
+
-`execution` (Attributes) (see [below for nested schema](#nestedatt--execution))
26
+
-`job_completion_trigger_condition` (Attributes) Whether the job is triggered by the completion of another job (see [below for nested schema](#nestedatt--job_completion_trigger_condition))
27
+
-`settings` (Attributes) (see [below for nested schema](#nestedatt--settings))
28
+
-`triggers` (Attributes) (see [below for nested schema](#nestedatt--triggers))
22
29
23
30
### Read-Only
24
31
25
-
-`deferring_environment_id` (Number) ID of the environment this job defers to
26
-
-`deferring_job_id` (Number) ID of the job this job defers to
27
-
-`description` (String) Long description for the job
28
-
-`environment_id` (Number) ID of the environment the job is in
29
-
-`id` (String) The ID of this resource.
30
-
-`job_completion_trigger_condition` (Set of Object) Which other job should trigger this job when it finishes, and on which conditions. (see [below for nested schema](#nestedatt--job_completion_trigger_condition))
31
-
-`name` (String) Given name for the job
32
-
-`run_compare_changes` (Boolean) Whether the CI job should compare data changes introduced by the code change in the PR.
33
-
-`self_deferring` (Boolean) Whether this job defers on a previous run of itself (overrides value in deferring_job_id)
34
-
-`timeout_seconds` (Number) Number of seconds before the job times out
35
-
-`triggers` (Map of Boolean) Flags for which types of triggers to use, keys of github_webhook, git_provider_webhook, schedule, on_merge
32
+
-`dbt_version` (String) The version of dbt used for the job. If not set, the environment version will be used.
33
+
-`deferring_environment_id` (Number) The ID of the environment this job defers to
34
+
-`deferring_job_definition_id` (Number) [Deprecated - deferral is now set at the environment level] The ID of the job definition this job defers to
35
+
-`description` (String) The description of the job
36
+
-`environment_id` (Number) The ID of environment
37
+
-`execute_steps` (List of String) The list of steps to run in the job
38
+
-`generate_docs` (Boolean) Whether the job generate docs
39
+
-`id` (Number) The ID of the job
40
+
-`job_type` (String) The type of job (e.g. CI, scheduled)
41
+
-`name` (String) The name of the job
42
+
-`project_id` (Number) The ID of the project
43
+
-`run_compare_changes` (Boolean) Whether the job should compare data changes introduced by the code change in the PR
44
+
-`run_generate_sources` (Boolean) Whether the job test source freshness
45
+
-`schedule` (Attributes) (see [below for nested schema](#nestedatt--schedule))
36
46
-`triggers_on_draft_pr` (Boolean) Whether the CI job should be automatically triggered on draft PRs
37
47
48
+
<aid="nestedatt--environment"></a>
49
+
### Nested Schema for `environment`
50
+
51
+
Read-Only:
52
+
53
+
-`deployment_type` (String) Type of deployment environment: staging, production
54
+
-`id` (Number) ID of the environment
55
+
-`name` (String) Name of the environment
56
+
-`project_id` (Number)
57
+
-`type` (String) Environment type: development or deployment
58
+
59
+
60
+
<aid="nestedatt--execution"></a>
61
+
### Nested Schema for `execution`
62
+
63
+
Read-Only:
64
+
65
+
-`timeout_seconds` (Number) The number of seconds before the job times out
Copy file name to clipboardExpand all lines: docs/data-sources/jobs.md
+17-13Lines changed: 17 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -45,27 +45,31 @@ locals {
45
45
<aid="nestedatt--jobs"></a>
46
46
### Nested Schema for `jobs`
47
47
48
+
Optional:
49
+
50
+
-`environment` (Attributes) Details of the environment the job is running in (see [below for nested schema](#nestedatt--jobs--environment))
51
+
-`execution` (Attributes) (see [below for nested schema](#nestedatt--jobs--execution))
52
+
-`job_completion_trigger_condition` (Attributes) Whether the job is triggered by the completion of another job (see [below for nested schema](#nestedatt--jobs--job_completion_trigger_condition))
53
+
-`settings` (Attributes) (see [below for nested schema](#nestedatt--jobs--settings))
54
+
-`triggers` (Attributes) (see [below for nested schema](#nestedatt--jobs--triggers))
55
+
48
56
Read-Only:
49
57
50
58
-`dbt_version` (String) The version of dbt used for the job. If not set, the environment version will be used.
51
59
-`deferring_environment_id` (Number) The ID of the environment this job defers to
52
60
-`deferring_job_definition_id` (Number) [Deprecated - deferral is now set at the environment level] The ID of the job definition this job defers to
53
61
-`description` (String) The description of the job
54
-
-`environment` (Attributes) Details of the environment the job is running in (see [below for nested schema](#nestedatt--jobs--environment))
55
62
-`environment_id` (Number) The ID of environment
56
63
-`execute_steps` (List of String) The list of steps to run in the job
57
-
-`execution` (Attributes) (see [below for nested schema](#nestedatt--jobs--execution))
58
64
-`generate_docs` (Boolean) Whether the job generate docs
59
65
-`id` (Number) The ID of the job
60
-
-`job_completion_trigger_condition` (Attributes) Whether the job is triggered by the completion of another job (see [below for nested schema](#nestedatt--jobs--job_completion_trigger_condition))
66
+
-`job_id` (Number) The ID of the job
61
67
-`job_type` (String) The type of job (e.g. CI, scheduled)
62
68
-`name` (String) The name of the job
63
69
-`project_id` (Number) The ID of the project
64
70
-`run_compare_changes` (Boolean) Whether the job should compare data changes introduced by the code change in the PR
65
71
-`run_generate_sources` (Boolean) Whether the job test source freshness
66
72
-`schedule` (Attributes) (see [below for nested schema](#nestedatt--jobs--schedule))
67
-
-`settings` (Attributes) (see [below for nested schema](#nestedatt--jobs--settings))
68
-
-`triggers` (Attributes) (see [below for nested schema](#nestedatt--jobs--triggers))
69
73
-`triggers_on_draft_pr` (Boolean) Whether the CI job should be automatically triggered on draft PRs
70
74
71
75
<aid="nestedatt--jobs--environment"></a>
@@ -106,14 +110,6 @@ Read-Only:
106
110
107
111
108
112
109
-
<aid="nestedatt--jobs--schedule"></a>
110
-
### Nested Schema for `jobs.schedule`
111
-
112
-
Read-Only:
113
-
114
-
-`cron` (String) The cron schedule for the job. Only used if triggers.schedule is true
115
-
116
-
117
113
<aid="nestedatt--jobs--settings"></a>
118
114
### Nested Schema for `jobs.settings`
119
115
@@ -132,3 +128,11 @@ Read-Only:
132
128
-`github_webhook` (Boolean) Whether the job runs automatically on PR creation
133
129
-`on_merge` (Boolean) Whether the job runs automatically once a PR is merged
134
130
-`schedule` (Boolean) Whether the job runs on a schedule
131
+
132
+
133
+
<aid="nestedatt--jobs--schedule"></a>
134
+
### Nested Schema for `jobs.schedule`
135
+
136
+
Read-Only:
137
+
138
+
-`cron` (String) The cron schedule for the job. Only used if triggers.schedule is true
0 commit comments