chore: decouple client stub objects and rely on common stub settings object.

Author: arpan14

google-cloud-spanner/clirr-ignored-differences.xml

@@ -555,12 +555,12 @@
   <difference>
     <differenceType>7012</differenceType>
     <className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
-    <method>com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub getDatabaseAdminStub()</method>
+    <method>com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings getDatabaseAdminStubSettings()</method>
   </difference>
   <difference>
     <differenceType>7012</differenceType>
     <className>com/google/cloud/spanner/spi/v1/SpannerRpc</className>
-    <method>com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub getInstanceAdminStub()</method>
+    <method>com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings getInstanceAdminStubSettings()</method>
   </difference>
 
   <difference>

google-cloud-spanner/src/main/java/com/google/cloud/spanner/Spanner.java

@@ -44,8 +44,8 @@ public interface Spanner extends Service<SpannerOptions>, AutoCloseable {
   DatabaseAdminClient getDatabaseAdminClient();
 
   /**
-   * Returns a {@link com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient} to execute admin
-   * operations on Cloud Spanner databases.
+   * Returns a {@link com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient} to execute
+   * admin operations on Cloud Spanner databases.
    *
    * @return {@link com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient}
    */
@@ -79,8 +79,8 @@ default com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient databaseA
   InstanceAdminClient getInstanceAdminClient();
 
   /**
-   * Returns an {@link com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient} to execute admin
-   * operations on Cloud Spanner instances.
+   * Returns an {@link com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient} to execute
+   * admin operations on Cloud Spanner instances.
    *
    * @return {@link com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient}
    */

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerImpl.java

@@ -42,6 +42,7 @@
 import io.opencensus.trace.Tracing;
 import io.opentelemetry.api.common.Attributes;
 import io.opentelemetry.api.common.AttributesBuilder;
+import java.io.IOException;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
@@ -150,12 +151,8 @@ static final class ClosedException extends RuntimeException {
     this.dbAdminClient = new DatabaseAdminClientImpl(options.getProjectId(), gapicRpc);
     this.instanceClient =
         new InstanceAdminClientImpl(options.getProjectId(), gapicRpc, dbAdminClient);
-    this.databaseAdminClient =
-        com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.create(
-            gapicRpc.getDatabaseAdminStub());
-    this.instanceAdminClient =
-        com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient.create(
-            gapicRpc.getInstanceAdminStub());
+    this.databaseAdminClient = createDatabaseAdminClient();
+    this.instanceAdminClient = createInstanceAdminClient();
   }
 
   SpannerImpl(SpannerOptions options) {
@@ -365,4 +362,24 @@ void setNextPageToken(String nextPageToken) {
 
     abstract S fromProto(T proto);
   }
+
+  private com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient
+      createInstanceAdminClient() {
+    try {
+      return com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient.create(
+          gapicRpc.getInstanceAdminStubSettings().createStub());
+    } catch (IOException ex) {
+      throw SpannerExceptionFactory.newSpannerException(ex);
+    }
+  }
+
+  private com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient
+      createDatabaseAdminClient() {
+    try {
+      return com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient.create(
+          gapicRpc.getDatabaseAdminStubSettings().createStub());
+    } catch (IOException ex) {
+      throw SpannerExceptionFactory.newSpannerException(ex);
+    }
+  }
 }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/GapicSpannerRpc.java

@@ -243,6 +243,7 @@ public class GapicSpannerRpc implements SpannerRpc {
   private final Set<Code> readRetryableCodes;
   private final SpannerStub partitionedDmlStub;
   private final RetrySettings partitionedDmlRetrySettings;
+  private final InstanceAdminStubSettings instanceAdminStubSettings;
   private final InstanceAdminStub instanceAdminStub;
   private final DatabaseAdminStubSettings databaseAdminStubSettings;
   private final DatabaseAdminStub databaseAdminStub;
@@ -435,16 +436,15 @@ public GapicSpannerRpc(final SpannerOptions options) {
                   .withCheckInterval(pdmlSettings.getStreamWatchdogCheckInterval()));
         }
         this.partitionedDmlStub = GrpcSpannerStub.create(pdmlSettings.build());
-
-        this.instanceAdminStub =
-            GrpcInstanceAdminStub.create(
-                options
-                    .getInstanceAdminStubSettings()
-                    .toBuilder()
-                    .setTransportChannelProvider(channelProvider)
-                    .setCredentialsProvider(credentialsProvider)
-                    .setStreamWatchdogProvider(watchdogProvider)
-                    .build());
+        this.instanceAdminStubSettings =
+            options
+                .getInstanceAdminStubSettings()
+                .toBuilder()
+                .setTransportChannelProvider(channelProvider)
+                .setCredentialsProvider(credentialsProvider)
+                .setStreamWatchdogProvider(watchdogProvider)
+                .build();
+        this.instanceAdminStub = GrpcInstanceAdminStub.create(instanceAdminStubSettings);
 
         this.databaseAdminStubSettings =
             options
@@ -510,6 +510,7 @@ public <RequestT, ResponseT> UnaryCallable<RequestT, ResponseT> createUnaryCalla
       this.executeQueryRetryableCodes = null;
       this.partitionedDmlStub = null;
       this.databaseAdminStubSettings = null;
+      this.instanceAdminStubSettings = null;
       this.spannerWatchdog = null;
       this.partitionedDmlRetrySettings = null;
     }
@@ -2005,13 +2006,13 @@ public boolean isClosed() {
   }
 
   @Override
-  public DatabaseAdminStub getDatabaseAdminStub() {
-    return databaseAdminStub;
+  public DatabaseAdminStubSettings getDatabaseAdminStubSettings() {
+    return databaseAdminStubSettings;
   }
 
   @Override
-  public InstanceAdminStub getInstanceAdminStub() {
-    return instanceAdminStub;
+  public InstanceAdminStubSettings getInstanceAdminStubSettings() {
+    return instanceAdminStubSettings;
   }
 
   private static final class GrpcStreamingCall implements StreamingCall {

google-cloud-spanner/src/main/java/com/google/cloud/spanner/spi/v1/SpannerRpc.java

@@ -28,7 +28,9 @@
 import com.google.cloud.spanner.Restore;
 import com.google.cloud.spanner.SpannerException;
 import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStub;
+import com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings;
 import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStub;
+import com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings;
 import com.google.cloud.spanner.v1.stub.SpannerStubSettings;
 import com.google.common.collect.ImmutableList;
 import com.google.iam.v1.GetPolicyOptions;
@@ -502,22 +504,22 @@ TestIamPermissionsResponse testInstanceAdminIAMPermissions(
   boolean isClosed();
 
   /**
-   * Getter method to obtain the auto-generated instance admin client stub.
+   * Getter method to obtain the auto-generated instance admin client stub settings.
    *
-   * @return InstanceAdminStub
+   * @return InstanceAdminStubSettings
    */
   @InternalApi
-  default InstanceAdminStub getInstanceAdminStub() {
+  default InstanceAdminStubSettings getInstanceAdminStubSettings() {
     throw new UnsupportedOperationException("Not implemented");
   }
 
   /**
-   * Getter method to obtain the auto-generated database admin client stub.
+   * Getter method to obtain the auto-generated database admin client stub settings.
    *
-   * @return DatabaseAdminStub
+   * @return DatabaseAdminStubSettings
    */
   @InternalApi
-  default DatabaseAdminStub getDatabaseAdminStub() {
+  default DatabaseAdminStubSettings getDatabaseAdminStubSettings() {
     throw new UnsupportedOperationException("Not implemented");
   }
 }