Skip to content

docs: clarify that the presence of XyzJob.errors doesn't necessarily mean that the job has not completed or was unsuccessful #2278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 8, 2025
Merged

docs: clarify that the presence of XyzJob.errors doesn't necessarily mean that the job has not completed or was unsuccessful #2278

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e93eecb
docs: clarify that the presence of `XyzJob.errors` doesn't necessari…
tswast Sep 5, 2025
8ef9ee3
Merge branch 'main' into tswast-patch-2
tswast Sep 8, 2025
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions google/cloud/bigquery/job/base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,12 @@ def transaction_info(self) -> Optional[TransactionInfo]:

@property
def error_result(self):
"""Error information about the job as a whole.
"""Output only. Final error result of the job.

If present, indicates that the job has completed and was unsuccessful.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatus.FIELDS.error_result

Returns:
Optional[Mapping]: the error information (None until set from the server).
Expand All @@ -704,7 +709,13 @@ def error_result(self):

@property
def errors(self):
"""Information about individual errors generated by the job.
"""Output only. The first errors encountered during the running of the job.

The final message includes the number of errors that caused the process to stop.
Errors here do not necessarily mean that the job has not completed or was unsuccessful.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatus.FIELDS.errors

Returns:
Optional[List[Mapping]]:
Expand All @@ -716,7 +727,12 @@ def errors(self):

@property
def state(self):
"""Status of the job.
"""Output only. Running state of the job.

Valid states include 'PENDING', 'RUNNING', and 'DONE'.

See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/Job#JobStatus.FIELDS.state

Returns:
Optional[str]:
Expand Down