feat: Add InputBytes to extract job statistics (#2998)

* feat: Add InputBytes to extract job statistics * feat: Add InputBytes to extract job statistics * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
googleapis · Nov 9, 2023 · 19b7c3a · 19b7c3a
1 parent 6d14b27
commit 19b7c3a
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -60,13 +60,13 @@ implementation 'com.google.cloud:google-cloud-bigquery'
 If you are using Gradle without BOM, add this to your dependencies:
 
 ```Groovy
-implementation 'com.google.cloud:google-cloud-bigquery:2.34.1'
+implementation 'com.google.cloud:google-cloud-bigquery:2.34.2'
 ```
 
 If you are using SBT, add this to your dependencies:
 
 ```Scala
-libraryDependencies += "com.google.cloud" % "google-cloud-bigquery" % "2.34.1"
+libraryDependencies += "com.google.cloud" % "google-cloud-bigquery" % "2.34.2"
 ```
 <!-- {x-version-update-end} -->
 
@@ -351,7 +351,7 @@ Java is a registered trademark of Oracle and/or its affiliates.
 [kokoro-badge-link-5]: http://storage.googleapis.com/cloud-devrel-public/java/badges/java-bigquery/java11.html
 [stability-image]: https://img.shields.io/badge/stability-stable-green
 [maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-bigquery.svg
-[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-bigquery/2.34.1
+[maven-version-link]: https://central.sonatype.com/artifact/com.google.cloud/google-cloud-bigquery/2.34.2
 [authentication]: https://github.com/googleapis/google-cloud-java#authentication
 [auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
 [predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles

diff --git a/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/JobStatistics.java b/google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/JobStatistics.java
@@ -101,16 +101,21 @@ public static class ExtractStatistics extends JobStatistics {
 
     private final List<Long> destinationUriFileCounts;
 
+    private final Long inputBytes;
+
     static final class Builder extends JobStatistics.Builder<ExtractStatistics, Builder> {
 
       private List<Long> destinationUriFileCounts;
 
+      private Long inputBytes;
+
       private Builder() {}
 
       private Builder(com.google.api.services.bigquery.model.JobStatistics statisticsPb) {
         super(statisticsPb);
         if (statisticsPb.getExtract() != null) {
           this.destinationUriFileCounts = statisticsPb.getExtract().getDestinationUriFileCounts();
+          this.inputBytes = statisticsPb.getExtract().getInputBytes();
         }
       }
 
@@ -119,6 +124,11 @@ Builder setDestinationUriFileCounts(List<Long> destinationUriFileCounts) {
         return self();
       }
 
+      Builder setInputBytes(Long inputBytes) {
+        this.inputBytes = inputBytes;
+        return self();
+      }
+
       @Override
       ExtractStatistics build() {
         return new ExtractStatistics(this);
@@ -128,6 +138,7 @@ ExtractStatistics build() {
     private ExtractStatistics(Builder builder) {
       super(builder);
       this.destinationUriFileCounts = builder.destinationUriFileCounts;
+      this.inputBytes = builder.inputBytes;
     }
 
     /**
@@ -139,6 +150,11 @@ public List<Long> getDestinationUriFileCounts() {
       return destinationUriFileCounts;
     }
 
+    /** Returns number of user bytes extracted into the result. */
+    public Long getInputBytes() {
+      return inputBytes;
+    }
+
     @Override
     ToStringHelper toStringHelper() {
       return super.toStringHelper().add("destinationUriFileCounts", destinationUriFileCounts);
@@ -159,9 +175,10 @@ public final int hashCode() {
 
     @Override
     com.google.api.services.bigquery.model.JobStatistics toPb() {
-      com.google.api.services.bigquery.model.JobStatistics statisticsPb = super.toPb();
-      return statisticsPb.setExtract(
-          new JobStatistics4().setDestinationUriFileCounts(destinationUriFileCounts));
+      JobStatistics4 extractStatisticsPb = new JobStatistics4();
+      extractStatisticsPb.setDestinationUriFileCounts(destinationUriFileCounts);
+      extractStatisticsPb.setInputBytes(inputBytes);
+      return super.toPb().setExtract(extractStatisticsPb);
     }
 
     static Builder newBuilder() {

diff --git a/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/JobStatisticsTest.java b/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/JobStatisticsTest.java
@@ -97,6 +97,7 @@ public class JobStatisticsTest {
           .setEndTime(END_TIME)
           .setStartTime(START_TIME)
           .setDestinationUriFileCounts(FILE_COUNT)
+          .setInputBytes(INPUT_BYTES)
           .build();
   private static final LoadStatistics LOAD_STATISTICS =
       LoadStatistics.newBuilder()
@@ -249,6 +250,7 @@ public void testBuilder() {
     assertEquals(START_TIME, EXTRACT_STATISTICS.getStartTime());
     assertEquals(END_TIME, EXTRACT_STATISTICS.getEndTime());
     assertEquals(FILE_COUNT, EXTRACT_STATISTICS.getDestinationUriFileCounts());
+    assertEquals(INPUT_BYTES, EXTRACT_STATISTICS.getInputBytes());
 
     assertEquals(CREATION_TIME, LOAD_STATISTICS.getCreationTime());
     assertEquals(START_TIME, LOAD_STATISTICS.getStartTime());
@@ -385,6 +387,7 @@ private void compareExtractStatistics(ExtractStatistics expected, ExtractStatist
     assertEquals(expected, value);
     compareStatistics(expected, value);
     assertEquals(expected.getDestinationUriFileCounts(), value.getDestinationUriFileCounts());
+    assertEquals(expected.getInputBytes(), value.getInputBytes());
   }
 
   private void compareLoadStatistics(LoadStatistics expected, LoadStatistics value) {

diff --git a/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/it/ITBigQueryTest.java b/google-cloud-bigquery/src/test/java/com/google/cloud/bigquery/it/ITBigQueryTest.java
@@ -87,6 +87,7 @@
 import com.google.cloud.bigquery.JobId;
 import com.google.cloud.bigquery.JobInfo;
 import com.google.cloud.bigquery.JobStatistics;
+import com.google.cloud.bigquery.JobStatistics.ExtractStatistics;
 import com.google.cloud.bigquery.JobStatistics.LoadStatistics;
 import com.google.cloud.bigquery.JobStatistics.QueryStatistics;
 import com.google.cloud.bigquery.JobStatistics.QueryStatistics.StatementType;
@@ -5304,6 +5305,8 @@ public void testExtractJob() throws InterruptedException, TimeoutException {
     assertNull(remoteLoadJob.getStatus().getError());
     LoadJobConfiguration loadJobConfiguration = remoteLoadJob.getConfiguration();
     assertEquals(labels, loadJobConfiguration.getLabels());
+    LoadStatistics loadStatistics = remoteLoadJob.getStatistics();
+    assertNotNull(loadStatistics);
 
     ExtractJobConfiguration extractConfiguration =
         ExtractJobConfiguration.newBuilder(destinationTable, "gs://" + BUCKET + "/" + EXTRACT_FILE)
@@ -5313,6 +5316,12 @@ public void testExtractJob() throws InterruptedException, TimeoutException {
     remoteExtractJob = remoteExtractJob.waitFor();
     assertNull(remoteExtractJob.getStatus().getError());
 
+    ExtractStatistics extractStatistics = remoteExtractJob.getStatistics();
+    assertNotNull(extractStatistics);
+    assertEquals(1L, extractStatistics.getDestinationUriFileCounts().size());
+    assertEquals(
+        loadStatistics.getOutputBytes().longValue(), extractStatistics.getInputBytes().longValue());
+
     String extractedCsv =
         new String(storage.readAllBytes(BUCKET, EXTRACT_FILE), StandardCharsets.UTF_8);
     assertEquals(