Skip to content

Commit 02b4ffa

Browse files
committed
Generate docs for testing incremental changes on PR
1 parent 6afef27 commit 02b4ffa

2 files changed

Lines changed: 98 additions & 28 deletions

File tree

docs/data-sources/job.md

Lines changed: 81 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@
33
page_title: "dbtcloud_job Data Source - dbtcloud"
44
subcategory: ""
55
description: |-
6-
6+
Retrieve a job by ID
77
---
88

99
# dbtcloud_job (Data Source)
1010

11-
11+
Retrieve a job by ID
1212

1313

1414

@@ -17,29 +17,95 @@ description: |-
1717

1818
### Required
1919

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))
2229

2330
### Read-Only
2431

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))
3646
- `triggers_on_draft_pr` (Boolean) Whether the CI job should be automatically triggered on draft PRs
3747

48+
<a id="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+
<a id="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
66+
67+
3868
<a id="nestedatt--job_completion_trigger_condition"></a>
3969
### Nested Schema for `job_completion_trigger_condition`
4070

4171
Read-Only:
4272

73+
- `condition` (Attributes) (see [below for nested schema](#nestedatt--job_completion_trigger_condition--condition))
74+
75+
<a id="nestedatt--job_completion_trigger_condition--condition"></a>
76+
### Nested Schema for `job_completion_trigger_condition.condition`
77+
78+
Read-Only:
79+
4380
- `job_id` (Number)
4481
- `project_id` (Number)
4582
- `statuses` (Set of String)
83+
84+
85+
86+
<a id="nestedatt--settings"></a>
87+
### Nested Schema for `settings`
88+
89+
Read-Only:
90+
91+
- `target_name` (String) Value for `target.name` in the Jinja context
92+
- `threads` (Number) Number of threads to run dbt with
93+
94+
95+
<a id="nestedatt--triggers"></a>
96+
### Nested Schema for `triggers`
97+
98+
Read-Only:
99+
100+
- `git_provider_webhook` (Boolean) Whether the job runs automatically on PR creation
101+
- `github_webhook` (Boolean) Whether the job runs automatically on PR creation
102+
- `on_merge` (Boolean) Whether the job runs automatically once a PR is merged
103+
- `schedule` (Boolean) Whether the job runs on a schedule
104+
105+
106+
<a id="nestedatt--schedule"></a>
107+
### Nested Schema for `schedule`
108+
109+
Read-Only:
110+
111+
- `cron` (String) The cron schedule for the job. Only used if triggers.schedule is true

docs/data-sources/jobs.md

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -45,27 +45,31 @@ locals {
4545
<a id="nestedatt--jobs"></a>
4646
### Nested Schema for `jobs`
4747

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+
4856
Read-Only:
4957

5058
- `dbt_version` (String) The version of dbt used for the job. If not set, the environment version will be used.
5159
- `deferring_environment_id` (Number) The ID of the environment this job defers to
5260
- `deferring_job_definition_id` (Number) [Deprecated - deferral is now set at the environment level] The ID of the job definition this job defers to
5361
- `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))
5562
- `environment_id` (Number) The ID of environment
5663
- `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))
5864
- `generate_docs` (Boolean) Whether the job generate docs
5965
- `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
6167
- `job_type` (String) The type of job (e.g. CI, scheduled)
6268
- `name` (String) The name of the job
6369
- `project_id` (Number) The ID of the project
6470
- `run_compare_changes` (Boolean) Whether the job should compare data changes introduced by the code change in the PR
6571
- `run_generate_sources` (Boolean) Whether the job test source freshness
6672
- `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))
6973
- `triggers_on_draft_pr` (Boolean) Whether the CI job should be automatically triggered on draft PRs
7074

7175
<a id="nestedatt--jobs--environment"></a>
@@ -106,14 +110,6 @@ Read-Only:
106110

107111

108112

109-
<a id="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-
117113
<a id="nestedatt--jobs--settings"></a>
118114
### Nested Schema for `jobs.settings`
119115

@@ -132,3 +128,11 @@ Read-Only:
132128
- `github_webhook` (Boolean) Whether the job runs automatically on PR creation
133129
- `on_merge` (Boolean) Whether the job runs automatically once a PR is merged
134130
- `schedule` (Boolean) Whether the job runs on a schedule
131+
132+
133+
<a id="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

Comments
 (0)