Skip to content

docs(bigquery): replace broken troubleshooting-errors links - #15110

Merged
lqiu96 merged 2 commits into
googleapis:mainfrom
lqiu96:docs/bq-0a-fix-troubleshooting-errors-links
Nov 20, 2026
Merged

lqiu96 merged 2 commits into
googleapis:mainfrom
lqiu96:docs/bq-0a-fix-troubleshooting-errors-links

Conversation

@lqiu96

@lqiu96 lqiu96 commented Nov 20, 2026

Copy link
Copy Markdown
Member

Replace all 7 occurrences of the dead https://cloud.google.com/bigquery/troubleshooting-errors link (HTTP 404) across java-bigquery:

  • Point BigQuery API HTTP status code and ErrorProto (errors / errorResult / reason) references to https://docs.cloud.google.com/bigquery/docs/errors.
  • Add https://docs.cloud.google.com/bigquery/docs/error-messages as a companion @see link on BigQueryException for client-side and connectivity errors (such as Java read timeouts and SSL exceptions).

Files Updated

  • java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryError.java (getReason -> docs/errors)
  • java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryException.java (class Javadoc -> docs/errors and docs/error-messages; RETRYABLE_ERRORS comment -> docs/errors)
  • java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQuerySQLException.java (class Javadoc -> docs/errors)
  • java-bigquery/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/JobStatus.java (getError and getExecutionErrors -> docs/errors)
  • java-bigquery/samples/snippets/src/main/java/com/example/bigquery/SimpleApp.java (getExecutionErrors comment -> docs/errors)

Verification

  • Confirmed 0 remaining occurrences of troubleshooting-errors under java-bigquery/.
  • Verified fmt:check, checkstyle:check, and test-compile on java-bigquery/google-cloud-bigquery.
  • Documentation and comment changes only with no behavioral changes.

Replace all 7 occurrences of the dead https://cloud.google.com/bigquery/troubleshooting-errors link (HTTP 404) across java-bigquery:
- Point API HTTP status code and ErrorProto reason references (BigQueryError, BigQueryException, BigQuerySQLException, JobStatus, SimpleApp) to https://docs.cloud.google.com/bigquery/docs/errors.
- Add https://docs.cloud.google.com/bigquery/docs/error-messages as a companion @see link on BigQueryException for client-side and connectivity errors (such as Java read timeouts and SSL errors).

Verified with fmt:check, checkstyle:check, and test-compile.
@lqiu96
lqiu96 requested review from a team as code owners November 20, 2026 20:30

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates outdated documentation links across several BigQuery classes and sample files to point to the new error documentation paths. The reviewer recommends using the canonical public domain 'cloud.google.com' instead of 'docs.cloud.google.com' to avoid loading the links within the Google Cloud Console UI, which can require login and has a heavier interface.

@lqiu96
lqiu96 merged commit 92962ed into googleapis:main Nov 20, 2026
199 of 200 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants