feat: Add Builder class for DataFormatOptions

Author: lqiu96

google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/BigQueryOptions.java

@@ -17,6 +17,7 @@
 package com.google.cloud.bigquery;
 
 import com.google.api.core.BetaApi;
+import com.google.api.core.ObsoleteApi;
 import com.google.api.gax.retrying.ResultRetryAlgorithm;
 import com.google.cloud.ServiceDefaults;
 import com.google.cloud.ServiceOptions;
@@ -41,6 +42,7 @@ public class BigQueryOptions extends ServiceOptions<BigQuery, BigQueryOptions> {
   // set the option ThrowNotFound when you want to throw the exception when the value not found
   private boolean setThrowNotFound;
   private boolean useInt64Timestamps;
+  private final DataFormatOptions dataFormatOptions;
   private JobCreationMode defaultJobCreationMode = JobCreationMode.JOB_CREATION_MODE_UNSPECIFIED;
   private boolean enableOpenTelemetryTracing;
   private Tracer openTelemetryTracer;
@@ -70,6 +72,7 @@ public static class Builder extends ServiceOptions.Builder<BigQuery, BigQueryOpt
 
     private String location;
     private boolean useInt64Timestamps;
+    private DataFormatOptions dataFormatOptions = DataFormatOptions.newBuilder().build();
     private boolean enableOpenTelemetryTracing;
     private Tracer openTelemetryTracer;
     private ResultRetryAlgorithm<?> resultRetryAlgorithm;
@@ -94,11 +97,31 @@ public Builder setLocation(String location) {
       return this;
     }
 
+    /**
+     * This setter is marked as Obsolete. Prefer {@link #setDataFormatOptions(DataFormatOptions)} to
+     * set the int64timestamp configuration instead.
+     *
+     * <p>If useInt64Timestamps value is set in here and via DataFormatOptions, the
+     * DataFormatOptions configuration value is used.
+     *
+     * <p>{@code DataFormatOptions.newBuilder().setUseInt64Timestamp(...).build()}
+     */
+    @ObsoleteApi("Use setDataFormatOptions(DataFormatOptions) instead")
     public Builder setUseInt64Timestamps(boolean useInt64Timestamps) {
       this.useInt64Timestamps = useInt64Timestamps;
       return this;
     }
 
+    /**
+     * Set the format options for the BigQuery data types
+     *
+     * @param dataFormatOptions Configuration of the formatting options
+     */
+    public Builder setDataFormatOptions(DataFormatOptions dataFormatOptions) {
+      this.dataFormatOptions = dataFormatOptions;
+      return this;
+    }
+
     /**
      * Enables OpenTelemetry tracing functionality for this BigQuery instance
      *
@@ -136,6 +159,7 @@ private BigQueryOptions(Builder builder) {
     super(BigQueryFactory.class, BigQueryRpcFactory.class, builder, new BigQueryDefaults());
     this.location = builder.location;
     this.useInt64Timestamps = builder.useInt64Timestamps;
+    this.dataFormatOptions = builder.dataFormatOptions;
     this.enableOpenTelemetryTracing = builder.enableOpenTelemetryTracing;
     this.openTelemetryTracer = builder.openTelemetryTracer;
     if (builder.resultRetryAlgorithm != null) {
@@ -210,6 +234,10 @@ public boolean getUseInt64Timestamps() {
     return useInt64Timestamps;
   }
 
+  public DataFormatOptions getDataFormatOptions() {
+    return dataFormatOptions;
+  }
+
   public JobCreationMode getDefaultJobCreationMode() {
     return defaultJobCreationMode;
   }

google-cloud-bigquery/src/main/java/com/google/cloud/bigquery/DataFormatOptions.java

@@ -23,29 +23,59 @@ public String toString() {
     }
   }
 
-  private boolean useInt64Timestamp;
-  private TimestampFormatOptions timestampFormatOptions;
+  private final boolean useInt64Timestamp;
+  private final TimestampFormatOptions timestampFormatOptions;
 
-  public DataFormatOptions(
-      boolean useInt64Timestamp, TimestampFormatOptions timestampFormatOptions) {
-    this.useInt64Timestamp = useInt64Timestamp;
-    this.timestampFormatOptions = timestampFormatOptions;
+  DataFormatOptions() {
+    this(new Builder());
   }
 
-  public boolean isUseInt64Timestamp() {
-    return useInt64Timestamp;
+  DataFormatOptions(Builder builder) {
+    this.useInt64Timestamp = builder.useInt64Timestamp;
+    this.timestampFormatOptions = builder.timestampFormatOptions;
   }
 
-  public void setUseInt64Timestamp(boolean useInt64Timestamp) {
-    this.useInt64Timestamp = useInt64Timestamp;
+  public boolean isUseInt64Timestamp() {
+    return useInt64Timestamp;
   }
 
   public TimestampFormatOptions getTimestampFormatOptions() {
     return timestampFormatOptions;
   }
 
-  public void setTimestampFormatOptions(TimestampFormatOptions timestampFormatOptions) {
-    this.timestampFormatOptions = timestampFormatOptions;
+  public static Builder newBuilder() {
+    return new Builder();
+  }
+
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
+  public static class Builder {
+    private boolean useInt64Timestamp;
+    private TimestampFormatOptions timestampFormatOptions =
+        TimestampFormatOptions.TIMESTAMP_OUTPUT_FORMAT_UNSPECIFIED;
+
+    public Builder() {}
+
+    public Builder(DataFormatOptions dataFormatOptions) {
+      this.useInt64Timestamp = dataFormatOptions.useInt64Timestamp;
+      this.timestampFormatOptions = dataFormatOptions.timestampFormatOptions;
+    }
+
+    public Builder setUseInt64Timestamp(boolean useInt64Timestamp) {
+      this.useInt64Timestamp = useInt64Timestamp;
+      return this;
+    }
+
+    public Builder setTimestampFormatOptions(TimestampFormatOptions timestampFormatOptions) {
+      this.timestampFormatOptions = timestampFormatOptions;
+      return this;
+    }
+
+    public DataFormatOptions build() {
+      return new DataFormatOptions(this);
+    }
   }
 
   com.google.api.services.bigquery.model.DataFormatOptions toPb() {
@@ -59,8 +89,10 @@ com.google.api.services.bigquery.model.DataFormatOptions toPb() {
   }
 
   DataFormatOptions fromPb(com.google.api.services.bigquery.model.DataFormatOptions request) {
-    return new DataFormatOptions(
-        request.getUseInt64Timestamp(),
-        TimestampFormatOptions.valueOf(request.getTimestampOutputFormat()));
+    return new Builder()
+        .setUseInt64Timestamp(request.getUseInt64Timestamp())
+        .setTimestampFormatOptions(
+            TimestampFormatOptions.valueOf(request.getTimestampOutputFormat()))
+        .build();
   }
 }