docs(samples): jsonstreamwriter samples #756

VeronicaWasson · 2020-12-30T19:45:07Z

No description provided.

codecov · 2020-12-30T19:47:43Z

Codecov Report

Merging #756 (edd650d) into master (0491bcb) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##             master     #756   +/-   ##
=========================================
  Coverage     80.89%   80.89%           
  Complexity      992      992           
=========================================
  Files            74       74           
  Lines          5333     5333           
  Branches        412      412           
=========================================
  Hits           4314     4314           
  Misses          847      847           
  Partials        172      172

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0491bcb...edd650d. Read the comment docs.

stephaniewang526 · 2020-12-30T20:37:06Z

please follow docs(samples): region_tag sample format for initial commit and PR subject.

Example: googleapis/java-bigquery@37c0632

Please make sure to correct your initial commit.

VeronicaWasson · 2021-01-05T17:45:59Z

please follow docs(samples): region_tag sample format for initial commit and PR subject.

I added 'doc(samples)' - What should I use for region_tag and sample in this case?

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java

stephaniewang526 · 2020-12-30T20:36:21Z

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java

+package com.example.bigquerystorage;
+
+import com.google.api.core.ApiFuture;
+import com.google.cloud.bigquery.*;


please import only used packages and avoid *

stephaniewang526 · 2020-12-30T20:38:08Z

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java

+              .build()) {
+
+        int offsets[] = {0, 1, 2, 3, 4, 5, 5};
+        // The last offset is repeated. This will cause an ALREADY_EXISTS error.


The convention is to place the comment above the statement. More importantly, what is an offset and what does it do? Why are we showing a repeated offset if it causes an error?

stephaniewang526 · 2020-12-30T20:38:49Z

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java

+public class WriteCommittedStream {
+
+  public static Status.Code getStatusCode(StatusRuntimeException e) {
+    return e.getStatus().getCode();


this helper method seems redundant -- we can directly write this one liner in the sample body.

I removed this and simplified the exception handling.

stephaniewang526 · 2020-12-30T20:43:40Z

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java

+
+      System.out.println("Appended records successfully.");
+
+    } catch (Exception e) {


Is there a more specific type of Exception we can catch here?

There are several - Is it better to catch each type explicitly?

Fixed - now I catch a specific type and declare others as thrown

samples/snippets/src/main/java/com/example/bigquerystorage/WritePendingStream.java

stephaniewang526 · 2021-01-05T18:11:05Z

samples/snippets/src/test/java/com/example/bigquerystorage/WriteAPISampleIT.java

+ * limitations under the License.
+ */
+
+package com.example.bigquerystorage;


One test class per sample class please.

stephaniewang526 · 2021-01-05T18:13:59Z

samples/snippets/src/test/java/com/example/bigquerystorage/WriteAPISampleIT.java

+  @Test
+  public void testWriteCommittedStream() throws Exception {
+    WriteCommittedStream.writeCommittedStream(
+        GOOGLE_CLOUD_PROJECT, BIGQUERY_DATASET_NAME, BIGQUERY_TABLE_NAME);


it does not look like we are testing anything here.
we need to use Truth to assert that we are getting desirable print output. Something like: https://github.com/googleapis/java-bigquery/blob/9945ca699eb7e439da387c40ac338a473dd9cb81/samples/snippets/src/test/java/com/example/bigquery/CopyMultipleTablesIT.java#L77

stephaniewang526 · 2021-01-05T18:14:23Z

samples/snippets/src/test/java/com/example/bigquerystorage/WriteAPISampleIT.java

+  public void testWriteToDefaultStream() throws Exception {
+    WriteCommittedStream.writeToDefaultStream(
+        GOOGLE_CLOUD_PROJECT, BIGQUERY_DATASET_NAME, BIGQUERY_TABLE_NAME);
+  }


see above comment and also this should be in a separate test class.

stephaniewang526 · 2021-01-05T18:14:29Z

samples/snippets/src/test/java/com/example/bigquerystorage/WriteAPISampleIT.java

+  public void testWritePendingStream() throws Exception {
+    WritePendingStream.writePendingStream(
+        GOOGLE_CLOUD_PROJECT, BIGQUERY_DATASET_NAME, BIGQUERY_TABLE_NAME);
+  }


see above comment and also this should be in a separate test class.

stephaniewang526 · 2021-01-05T18:17:06Z

please follow docs(samples): region_tag sample format for initial commit and PR subject.

I added 'doc(samples)' - What should I use for region_tag and sample in this case?

region_tag needs to be created in devrel samples tracker so that it can go on the documentation site. please let me know if you would like me to create them.

stephaniewang526 · 2021-01-05T18:18:19Z

For Java samples general guidelines, PTAL: https://github.com/GoogleCloudPlatform/java-docs-samples/blob/master/SAMPLE_FORMAT.md

stephaniewang526 · 2021-01-05T18:24:08Z

Also prior to raising a PR, please:

run mvn verify locally in the project root to make sure the code is still compiling and all tests pass;
run mvn -P lint --quiet --batch-mode checkstyle:check in the samples directory to make sure there is no checkstyle errors; and
run mvn com.coveo:fmt-maven-plugin:format in the samples directory to reformat code.
If everything passed, you are ready to raise a PR!

snippet-bot · 2021-01-08T18:46:45Z

Here is the summary of changes.

You added 3 region tags.

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java:19, tag bigquerystorage_jsonstreamwriter_committed
samples/snippets/src/main/java/com/example/bigquerystorage/WritePendingStream.java:19, tag bigquerystorage_jsonstreamwriter_pending
samples/snippets/src/main/java/com/example/bigquerystorage/WriteToDefaultStream.java:19, tag bigquerystorage_jsonstreamwriter_default

This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run label or use the checkbox below:

Refresh this comment

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java

samples/snippets/src/main/java/com/example/bigquerystorage/WritePendingStream.java

samples/snippets/src/main/java/com/example/bigquerystorage/WriteToDefaultStream.java

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java

samples/snippets/src/main/java/com/example/bigquerystorage/WritePendingStream.java

gcf-merge-on-green · 2021-01-09T02:34:02Z

Merge-on-green attempted to merge your PR for 6 hours, but it was not mergeable because either one of your required status checks failed, one of your required reviews was not approved, or there is a do not merge label. Learn more about your required status checks here: https://help.github.com/en/github/administering-a-repository/enabling-required-status-checks. You can remove and reapply the label to re-run the bot.

Remove the backoff logic to keep the sample code simpler.

- Simplify code, remove duplicate-record example. - Split all snippets and tests into separate classes. - Add comments and javadocs links. - Clean up imports. - Add region tags. - Catch only specific exceptions. - Run linter and fmt-maven-plugin.

…teCommittedStream.java

…tePendingStream.java

…teToDefaultStream.java

…tePendingStream.java

…teCommittedStream.java

…tePendingStream.java

Create temporary dataset and table for sample integration tests

stephaniewang526 · 2021-01-12T16:57:55Z

@yirutang please whitelist the devrel CI testing project

com.google.api.gax.rpc.PermissionDeniedException: io.grpc.StatusRuntimeException: PERMISSION_DENIED: Project 779844219229 doesn't have permission to access Write API

full trace

VeronicaWasson requested a review from a team December 30, 2020 19:45

google-cla bot added the cla: yes This human has signed the Contributor License Agreement. label Dec 30, 2020

product-auto-label bot added api: bigquerystorage Issues related to the googleapis/java-bigquerystorage API. samples Issues that are directly related to samples. labels Dec 30, 2020

blunderbuss-gcf bot assigned chingor13 and kurtisvg Dec 30, 2020

stephaniewang526 self-requested a review December 30, 2020 20:52

VeronicaWasson force-pushed the writeapi_snippets branch from 0dca7de to 1d2ae21 Compare December 31, 2020 01:27

VeronicaWasson requested a review from a team December 31, 2020 01:27

VeronicaWasson force-pushed the writeapi_snippets branch from 1d2ae21 to 5cffc9c Compare December 31, 2020 01:29

VeronicaWasson changed the title ~~Code samples for JsonStreamWriter~~ docs(samples) JsonStreamWriter sample Jan 5, 2021

stephaniewang526 suggested changes Jan 5, 2021

View reviewed changes

stephaniewang526 unassigned chingor13 and kurtisvg Jan 5, 2021

VeronicaWasson changed the title ~~docs(samples) JsonStreamWriter sample~~ docs(samples): jsonstreamwriter samples Jan 8, 2021

blunderbuss-gcf bot assigned dzlier-gcp Jan 8, 2021

VeronicaWasson force-pushed the writeapi_snippets branch from c2072e4 to 936bfb1 Compare January 8, 2021 19:53

stephaniewang526 approved these changes Jan 8, 2021

View reviewed changes

stephaniewang526 reviewed Jan 8, 2021

View reviewed changes

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java Show resolved Hide resolved

stephaniewang526 reviewed Jan 8, 2021

View reviewed changes

samples/snippets/src/main/java/com/example/bigquerystorage/WriteCommittedStream.java Outdated Show resolved Hide resolved

stephaniewang526 reviewed Jan 8, 2021

View reviewed changes

samples/snippets/src/main/java/com/example/bigquerystorage/WritePendingStream.java Outdated Show resolved Hide resolved

stephaniewang526 added the automerge Merge the pull request once unit tests and other checks pass. label Jan 8, 2021

VeronicaWasson and others added 21 commits January 12, 2021 01:51

docs(samples): jsonstreamwriter samples

d1fa8db

Add copyright notice

d4ce98a

Remove allowUnknownFields parameter

bfb4403

Added retry with exponential backoff

c3735b5

Revert "Added retry with exponential backoff"

7bc0f79

Remove the backoff logic to keep the sample code simpler.

Addressed PR review feedback.

56ca8e5

- Simplify code, remove duplicate-record example. - Split all snippets and tests into separate classes. - Add comments and javadocs links. - Clean up imports. - Add region tags. - Catch only specific exceptions. - Run linter and fmt-maven-plugin.

docs(samples): Fix mismatched region tag

7135af1

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

3e47e5b

…teCommittedStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

f495b7a

…tePendingStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

eb2e351

…tePendingStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

4529da8

…tePendingStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

93a9da6

…teToDefaultStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

eca9750

…teToDefaultStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

0c411b2

…teToDefaultStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

10ee1ff

…teToDefaultStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

2cea8bc

…tePendingStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

f0bbd91

…teCommittedStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

5c68665

…teCommittedStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

c044a42

…teCommittedStream.java

Update samples/snippets/src/main/java/com/example/bigquerystorage/Wri…

ec2ea61

…tePendingStream.java

docs(samples): Create test resouces

edd650d

Create temporary dataset and table for sample integration tests

VeronicaWasson force-pushed the writeapi_snippets branch from f01023f to edd650d Compare January 12, 2021 02:09

stephaniewang526 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 12, 2021

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 12, 2021

stephaniewang526 added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 12, 2021

yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Jan 12, 2021

stephaniewang526 merged commit 929b2ce into googleapis:master Jan 13, 2021

shubhwip pushed a commit to shubhwip/java-bigquerystorage that referenced this pull request Oct 7, 2023

chore: cleanup cloud RAD generation (googleapis#1269) (googleapis#756)

76c6a0b

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(samples): jsonstreamwriter samples #756

docs(samples): jsonstreamwriter samples #756

VeronicaWasson commented Dec 30, 2020

codecov bot commented Dec 30, 2020 •

edited

Loading

stephaniewang526 commented Dec 30, 2020 •

edited

Loading

VeronicaWasson commented Jan 5, 2021 •

edited

Loading

stephaniewang526 Dec 30, 2020

VeronicaWasson Jan 8, 2021

stephaniewang526 Dec 30, 2020

VeronicaWasson Jan 8, 2021

stephaniewang526 Dec 30, 2020

VeronicaWasson Jan 8, 2021

stephaniewang526 Dec 30, 2020

VeronicaWasson Jan 6, 2021

VeronicaWasson Jan 8, 2021

stephaniewang526 Jan 5, 2021

stephaniewang526 Jan 5, 2021

stephaniewang526 Jan 5, 2021

stephaniewang526 Jan 5, 2021

stephaniewang526 commented Jan 5, 2021 •

edited

Loading

stephaniewang526 commented Jan 5, 2021 •

edited

Loading

stephaniewang526 commented Jan 5, 2021 •

edited

Loading

snippet-bot bot commented Jan 8, 2021 •

edited

Loading

gcf-merge-on-green bot commented Jan 9, 2021

stephaniewang526 commented Jan 12, 2021


		System.out.println("Appended records successfully.");

		} catch (Exception e) {

docs(samples): jsonstreamwriter samples #756

docs(samples): jsonstreamwriter samples #756

Conversation

VeronicaWasson commented Dec 30, 2020

codecov bot commented Dec 30, 2020 • edited Loading

Codecov Report

stephaniewang526 commented Dec 30, 2020 • edited Loading

VeronicaWasson commented Jan 5, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephaniewang526 commented Jan 5, 2021 • edited Loading

stephaniewang526 commented Jan 5, 2021 • edited Loading

stephaniewang526 commented Jan 5, 2021 • edited Loading

snippet-bot bot commented Jan 8, 2021 • edited Loading

gcf-merge-on-green bot commented Jan 9, 2021

stephaniewang526 commented Jan 12, 2021

codecov bot commented Dec 30, 2020 •

edited

Loading

stephaniewang526 commented Dec 30, 2020 •

edited

Loading

VeronicaWasson commented Jan 5, 2021 •

edited

Loading

stephaniewang526 commented Jan 5, 2021 •

edited

Loading

stephaniewang526 commented Jan 5, 2021 •

edited

Loading

stephaniewang526 commented Jan 5, 2021 •

edited

Loading

snippet-bot bot commented Jan 8, 2021 •

edited

Loading