Skip to content

Commit 0465c5f

Browse files
committed
Add documentation and fix fmt
1 parent fab4fab commit 0465c5f

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

databricks/sdk/mixins/jobs.py

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,22 @@ def get_run(self,
1111
include_history: Optional[bool] = None,
1212
include_resolved_values: Optional[bool] = None,
1313
page_token: Optional[str] = None) -> jobs.Run:
14+
"""
15+
This method fetches the details of a run identified by `run_id`. If the run has multiple pages of tasks or iterations,
16+
it will paginate through all pages and aggregate the results.
17+
18+
:param run_id: int
19+
The canonical identifier of the run for which to retrieve the metadata. This field is required.
20+
:param include_history: bool (optional)
21+
Whether to include the repair history in the response.
22+
:param include_resolved_values: bool (optional)
23+
Whether to include resolved parameter values in the response.
24+
:param page_token: str (optional)
25+
To list the next page or the previous page of job tasks, set this field to the value of the
26+
`next_page_token` or `prev_page_token` returned in the GetJob response.
27+
28+
:returns: :class:`Run`
29+
"""
1430
run = super().get_run(run_id,
1531
include_history=include_history,
1632
include_resolved_values=include_resolved_values,
@@ -23,7 +39,7 @@ def get_run(self,
2339
include_history=include_history,
2440
include_resolved_values=include_resolved_values,
2541
page_token=run.next_page_token)
26-
if (isPaginatingIterations):
42+
if isPaginatingIterations:
2743
run.iterations.extend(next_run.iterations)
2844
else:
2945
run.tasks.extend(next_run.tasks)

0 commit comments

Comments
 (0)