Repository navigation
docs(bigquery): fix inverted and factually outdated Javadocs - #15118
Merged
Merged
Conversation
Fix seven inverted or factually outdated Javadocs across java-bigquery: - InsertAllResponse.hasErrors(): fix inverted boolean documentation (!insertErrors.isEmpty()). - LoadConfiguration.ignoreUnknownValues() / setIgnoreUnknownValues(): fix duplicated 'If true' typo and clarify default is false. - DatasetInfo: replace outdated 'cannot control access at the table level' claim with table/view access note and IAM docs link. - TableInfo.setLabels() / getLabels(): remove outdated 'labels are experimental' wording (leaving @BetaApi unchanged) and add labels docs link. - QueryParameterValue: replace 'Struct parameters are currently not supported' with links to array() and struct(). - Range: fix [DATE, TIME, TIMESTAMP] to [DATE, DATETIME, TIMESTAMP] and add Range type docs links. - BigQuery.query(): remove obsolete QUERY_PREVIEW_ENABLED docs (removed in googleapis#3804 / 8fab9f2). Verified with fmt:check, checkstyle:check@checkstyle, test-compile, and javadoc -Xdoclint:syntax,html,reference.
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates and corrects the Javadoc documentation across several classes in the google-cloud-bigquery library. Key updates include removing outdated references to experimental features (such as query preview features and table labels), correcting documentation typos (such as fixing the description of InsertAllResponse.hasErrors() and LoadConfiguration's unknown values handling), updating supported types for Range (correcting TIME to DATETIME), and adding helpful links to official Google Cloud documentation. There are no review comments to address, and we have no additional feedback to provide.
jinseopkim0
approved these changes
Nov 20, 2026
lqiu96
added a commit
that referenced
this pull request
Nov 21, 2026
Updates 157 malformed, legacy, and broken-anchor documentation URLs across 33 files in `java-bigquery` (Javadoc and comment-only, no behavioral changes). ### Summary of changes - Fix malformed `hhttps://` URL in `ExternalTableDefinition.java`. - Replace pre-`/docs/` `cloud.google.com/bigquery/...` links (which no longer resolve to canonical documentation pages or drop section anchors) with canonical `https://docs.cloud.google.com/bigquery/...` destinations and exact section anchors (for example, `quotas#query_jobs`, `sessions#create-session`, `adding-labels#adding_dataset_labels`, and `biglake-intro#metadata_caching_for_performance`). - Update legacy `/docs/reference/v2/...` URLs and broken camelCase anchors to `/docs/reference/rest/v2/...` with live REST schema, field, and enum anchors (including pointing `JobInfo` and `BigQuery.JobField` to `/rest/v2/Job`, `LoadConfiguration.setFormatOptions` to `Job#JobConfigurationLoad.FIELDS.source_format`, `ExternalTableDefinition` and `CopyJobConfiguration` to exact `.FIELDS.*` anchors, `RoutineInfo` to `#routinetype` and `#datagovernancetype`, and `BigQuery.TableMetadataView`'s link label to `TableMetadataView`). - Fix wrong-topic links for `TableDefinition.Type.MATERIALIZED_VIEW` (`materialized-views-intro`), `ModelTableDefinition`, and `TableDefinition.Type.MODEL` (`bqml-introduction`). - Replace the legacy `developers.google.com` Discovery Javadoc link in `BigQueryDryRunResult.java` with the canonical REST `Job#JobStatistics2.FIELDS.undeclared_query_parameters` anchor. - Update broken `cloud.google.com/bigquery/pricing#storage` and `#long-term-storage` anchors to `#storage-pricing`. - Migrate remaining `cloud.google.com/bigquery/docs/...` and `cloud.google.com/iam/docs/...` links to `docs.cloud.google.com`. Note: Four lines currently touched by open PRs #15117 and #15118 are skipped here to avoid merge conflicts (`DatasetInfo.java:41` will be updated in a follow-up after #15118 merges). Historical GitHub issue comments are preserved. ### Verification - Every unique target URL (71/71) verified live with HTTP 200, 0 redirects, and matching HTML `id=` anchors where fragments are present - `mvn -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,reference` on all 33 modified files (0 warnings/errors)
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.
Fixes seven inverted or factually outdated Javadocs across
java-bigquery(documentation and comment changes only, with no behavioral or API signature changes):InsertAllResponse.hasErrors(): Javadoc was inverted (statedtruewhen no row failed, while the implementation returns!insertErrors.isEmpty()).LoadConfiguration.ignoreUnknownValues()/setIgnoreUnknownValues(): Fixed duplicatedIf {@code true}typo on the getter (the second branch isfalse, matching the builder) and clarifiedDefaults to {@code false}on both.DatasetInfo: Removed outdated claim that access cannot be controlled at the table level (BigQueryexposes table-level IAM methods) and added a link to Control access to resources with IAM.TableInfo.setLabels()/getLabels(): Removed outdated "labels are experimental" text (matchingDatasetInfo, leaving@BetaApiannotations untouched) and added a link to Introduction to labels.QueryParameterValue: Replaced outdated "Struct parameters are currently not supported" with@linkpointers toarray(...)andstruct(Map), which are implemented in the same class.Range: Fixed[DATE, TIME, TIMESTAMP]to[DATE, DATETIME, TIMESTAMP](matching line 86 and BigQuery SQL) and added links to BigQuery Range type.BigQuery.query(): Removed obsoleteQUERY_PREVIEW_ENABLEDenvironment variable docs (removed in Release v0.67.0 #3804 / commit8fab9f2ef4a3whenJobCreationModereached GA).Verification
fmt:check,checkstyle:check@checkstyle,test-compile, andjavadoc -Xdoclint:syntax,html,reference.