bigquery: BigQuery.writer return type should be public.#1394
bigquery: BigQuery.writer return type should be public.#1394tswast wants to merge 1 commit intogoogleapis:masterfrom
Conversation
The `BigQuery.writer` function does not link to its return type in the javadocs. http://googlecloudplatform.github.io/google-cloud-java/0.5.1/apidocs/com/google/cloud/bigquery/BigQuery.html#writer(com.google.cloud.bigquery.WriteChannelConfiguration) I believe this is because `TableDataWriteChannel` is package-private. Since the snippets use `BaseWriteChannel<BigQueryOptions, WriteChannelConfiguration>` as the variable type, I changed the type to this public type rather than making `TableDataWriteChannel` public.
|
@mziccard @lesv Maybe this method should return http://googlecloudplatform.github.io/google-cloud-java/0.5.1/apidocs/com/google/cloud/WriteChannel.html instead? In that case, I'd want to update the snippets, too. |
lesv
left a comment
There was a problem hiding this comment.
You probably should deprecate the existing version, then provide the new version. That's more or less the policy they've established.
|
Makes sense, though this isn't really a breaking change. No one could have used the return type it had before. |
|
If writer is fairly recent, then I'm ok with out the |
|
Closing based on #1392 (comment) We'll probably make |
…datatransfer to v2.2.4 (#1394) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.cloud:google-cloud-bigquerydatatransfer](https://togithub.com/googleapis/java-bigquerydatatransfer) | `2.2.3` -> `2.2.4` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Renovate will not automatically rebase this PR, because other commits have been found. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, click this checkbox. ⚠ **Warning**: custom changes will be lost. --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/googleapis/java-bigquerydatatransfer).
🤖 I have created a release *beep* *boop* --- ## [3.7.1](https://togithub.com/googleapis/java-asset/compare/v3.7.0...v3.7.1) (2022-10-07) ### Dependencies * Update dependency com.google.api.grpc:proto-google-cloud-orgpolicy-v1 to v2.3.6 ([googleapis#1390](https://togithub.com/googleapis/java-asset/issues/1390)) ([4219b66](https://togithub.com/googleapis/java-asset/commit/4219b66da58325f5a133caa84243dc0958d90149)) * Update dependency com.google.api.grpc:proto-google-cloud-os-config-v1 to v2.5.6 ([googleapis#1382](https://togithub.com/googleapis/java-asset/issues/1382)) ([3abde9e](https://togithub.com/googleapis/java-asset/commit/3abde9e4130d62d9e6857dd3b016be88691bd7f4)) * Update dependency com.google.api.grpc:proto-google-cloud-pubsub-v1 to v1.102.20 ([googleapis#1384](https://togithub.com/googleapis/java-asset/issues/1384)) ([5904111](https://togithub.com/googleapis/java-asset/commit/5904111205fc7c698703eb8db805b159a6513389)) * Update dependency com.google.api.grpc:proto-google-identity-accesscontextmanager-v1 to v1.4.5 ([googleapis#1383](https://togithub.com/googleapis/java-asset/issues/1383)) ([48f2dd8](https://togithub.com/googleapis/java-asset/commit/48f2dd863c23ec3fffb24970046cab6795a64045)) * Update dependency com.google.cloud:google-cloud-bigquery to v2.17.0 ([googleapis#1386](https://togithub.com/googleapis/java-asset/issues/1386)) ([d3cf534](https://togithub.com/googleapis/java-asset/commit/d3cf534180a8b0c4a421ff52a998b43edd502e6c)) * Update dependency com.google.cloud:google-cloud-core to v2.8.20 ([googleapis#1380](https://togithub.com/googleapis/java-asset/issues/1380)) ([113b74e](https://togithub.com/googleapis/java-asset/commit/113b74e29f05047ba3eb22cee370b2b35b133991)) * Update dependency com.google.cloud:google-cloud-pubsub to v1.120.20 ([googleapis#1385](https://togithub.com/googleapis/java-asset/issues/1385)) ([792d9a2](https://togithub.com/googleapis/java-asset/commit/792d9a2aa2253e4cb6541c587810aab936aa9d81)) * Update dependency com.google.cloud:google-cloud-resourcemanager to v1.5.6 ([googleapis#1391](https://togithub.com/googleapis/java-asset/issues/1391)) ([9afc924](https://togithub.com/googleapis/java-asset/commit/9afc924fbe87b481dc3b731935d3dc021e1bae00)) * Update dependency com.google.cloud:google-cloud-storage to v2.13.0 ([googleapis#1392](https://togithub.com/googleapis/java-asset/issues/1392)) ([9660ee4](https://togithub.com/googleapis/java-asset/commit/9660ee42c68e7cb88e0d6867ac46f2cd6056ca17)) --- This PR was generated with [Release Please](https://togithub.com/googleapis/release-please). See [documentation](https://togithub.com/googleapis/release-please#release-please).
…onfig to v1.5.7 (#1394) [](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [com.google.cloud:google-cloud-shared-config](https://togithub.com/googleapis/java-shared-config) | `1.5.6` -> `1.5.7` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>googleapis/java-shared-config (com.google.cloud:google-cloud-shared-config)</summary> ### [`v1.5.7`](https://togithub.com/googleapis/java-shared-config/blob/HEAD/CHANGELOG.md#157-2023-07-19) [Compare Source](https://togithub.com/googleapis/java-shared-config/compare/v1.5.6...v1.5.7) ##### Dependencies - Update auto-value-annotation.version to v1.10.2 ([#​632](https://togithub.com/googleapis/java-shared-config/issues/632)) ([bfa9559](https://togithub.com/googleapis/java-shared-config/commit/bfa9559bf96802cc717b3e8452d09f495f7e1e90)) - Update dependency com.google.auto.service:auto-service-annotations to v1.1.1 ([#​623](https://togithub.com/googleapis/java-shared-config/issues/623)) ([3405245](https://togithub.com/googleapis/java-shared-config/commit/3405245576821db2a10ae6efe22c5a8b656ce026)) - Update dependency com.puppycrawl.tools:checkstyle to v10.12.1 ([#​630](https://togithub.com/googleapis/java-shared-config/issues/630)) ([3d5a358](https://togithub.com/googleapis/java-shared-config/commit/3d5a358f7a82fa91869a39d770f4826cfb50e6b9)) - Update dependency org.graalvm.buildtools:native-maven-plugin to v0.9.23 ([#​627](https://togithub.com/googleapis/java-shared-config/issues/627)) ([274f269](https://togithub.com/googleapis/java-shared-config/commit/274f2692e20e8f9e4b390a3da14f7fcd4ecf7bdf)) - Update dependency org.junit.vintage:junit-vintage-engine to v5.9.3 ([#​624](https://togithub.com/googleapis/java-shared-config/issues/624)) ([88f4043](https://togithub.com/googleapis/java-shared-config/commit/88f4043f869406cf2a4544dbabdfd9b52365aca8)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/googleapis/java-logging). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNi4xMS4wIiwidXBkYXRlZEluVmVyIjoiMzYuMTEuMCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==-->
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
Co-authored-by: Alice <[email protected]>
The
BigQuery.writerfunction does not link to its return type in thejavadocs.
http://googlecloudplatform.github.io/google-cloud-java/0.5.1/apidocs/com/google/cloud/bigquery/BigQuery.html#writer(com.google.cloud.bigquery.WriteChannelConfiguration)
I believe this is because
TableDataWriteChannelis package-private.Since the snippets use
BaseWriteChannel<BigQueryOptions, WriteChannelConfiguration>as the variable type, I changed the type tothis public type rather than making
TableDataWriteChannelpublic.