Repository navigation
docs(bigquery): document structured error reasons and retryability on BigQueryException - #15125
Merged
lqiu96 merged 1 commit intoNov 20, 2026
Conversation
… BigQueryException
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the Javadoc documentation for BigQueryError and BigQueryException to provide clearer guidance on how to handle and classify transient versus permanent failures using structured error reasons and HTTP status codes. There are no review comments, and I have no additional feedback to provide on these documentation improvements.
jinseopkim0
approved these changes
Nov 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarifies error classification and retryability semantics in
BigQueryExceptionandBigQueryError.getReason()Javadocs (Javadoc-only, no behavioral changes).Summary of changes
BigQueryException: document that BigQuery communicates transient vs. permanent failures through structured error reasons (getReason(),getError(),getErrors()) rather than HTTP status codes alone (for example, rate-limit errors may return HTTP 403 and job-execution errors surface withgetCode() == 0).BigQueryException: document thatisRetryable()classifies only HTTP 500, 502, 503, 504, and low-level transportIOExceptionfailures as retryable, and that transient asynchronous job failures must be resubmitted as a new job with a newJobIdrather than re-polling the failed job.BigQueryError.getReason(): clarify that the error reason string is the primary signal alongside HTTP status for distinguishing transient from permanent failures.Verification
BigQueryException.java(RETRYABLE_ERRORS, constructors) andBigQueryExceptionTest.javamvn -pl java-bigquery/google-cloud-bigquery com.spotify.fmt:fmt-maven-plugin:check -Dlint checkstyle:check@checkstyle test-compile(0 Checkstyle violations)javadoc -Xdoclint:syntax,html,referenceon both modified files (0 warnings/errors)