BigQuery Storage: Add shim layer settings and configuration (#4022)

* Create a shim layer for the BigQuery Storage API.

This change adds a simple shim layer to the BigQuery Storage API client.
It is modeled after the shim layer in the Cloud Bigtable client, but
unlike that implementation, it does not create chained instances of
unary and server-streaming callables to perform translation; instead,
its parameters are simple pass-throughs to the underlying gRPC client
stub.

The shim currently does nothing but read default values from the base
client layer and pass them back through.

* Set the default gRPC inbound message size.

This change sets the default value for the maximum inbound message size
in the BigQuery Storage API client. A ReadRowsResponse object can
contain serialized row block of up to 10 MB in size if the underlying
row(s) are sufficiently large.

* Update the default timeout value for ReadRows.

This change modifies the default client-side timeout value for the
ReadRows API. ReadRows calls can last for long periods in the case of
large tables. The default timeout value is set to a full day, which is
the duration for which a read session is valid.

* Add a resumption strategy for ReadRows.

This change modifies the configuration for the ReadRows API to add a
resumption strategy, allowing the connection to be resumed transparently
in the case of transient errors.

Author: kmjung

google-cloud-clients/google-cloud-bigquerystorage/pom.xml

@@ -57,6 +57,21 @@
             <version>4.12</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.mockito</groupId>
+            <artifactId>mockito-all</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.google.truth</groupId>
+            <artifactId>truth</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>io.grpc</groupId>
+            <artifactId>grpc-testing</artifactId>
+            <scope>test</scope>
+        </dependency>
         <dependency>
             <groupId>com.google.api</groupId>
             <artifactId>gax</artifactId>

google-cloud-clients/google-cloud-bigquerystorage/src/main/java/com/google/cloud/bigquery/storage/v1beta1/BigQueryStorageClient.java

@@ -0,0 +1,235 @@
+/*
+ * Copyright 2018 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package com.google.cloud.bigquery.storage.v1beta1;
+
+import com.google.api.core.ApiFunction;
+import com.google.api.core.BetaApi;
+import com.google.api.gax.core.GoogleCredentialsProvider;
+import com.google.api.gax.core.InstantiatingExecutorProvider;
+import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
+import com.google.api.gax.rpc.ApiClientHeaderProvider;
+import com.google.api.gax.rpc.ClientContext;
+import com.google.api.gax.rpc.ClientSettings;
+import com.google.api.gax.rpc.ServerStreamingCallSettings;
+import com.google.api.gax.rpc.TransportChannelProvider;
+import com.google.api.gax.rpc.UnaryCallSettings;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsRequest;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.BatchCreateReadSessionStreamsResponse;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.CreateReadSessionRequest;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.FinalizeStreamRequest;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsRequest;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadRowsResponse;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.ReadSession;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamRequest;
+import com.google.cloud.bigquery.storage.v1beta1.Storage.SplitReadStreamResponse;
+import com.google.cloud.bigquery.storage.v1beta1.stub.EnhancedBigQueryStorageStubSettings;
+import com.google.protobuf.Empty;
+import java.io.IOException;
+import java.util.List;
+
+/**
+ * Settings class to configure an instance of {@link BigQueryStorageClient}.
+ *
+ * <p>The default instance has everything set to sensible defaults:
+ *
+ * <ul>
+ *   <li>The default service address (bigquerystorage.googleapis.com) and default port (443) are
+ *       used.
+ *   <li>Credentials are acquired automatically through Application Default Credentials.
+ *   <li>Retries are configured for idempotent methods but not for non-idempotent methods.
+ * </ul>
+ *
+ * <p>The builder of this class is recursive, so contained classes are themselves builders. When
+ * build() is called, the tree of builders is called to create the complete settings object. For
+ * example, to set the total timeout of createReadSession to 30 seconds:
+ *
+ * <pre>
+ * <code>
+ * BigQueryStorageSettings.Builder settingsBuilder = BaseBigQueryStorageSettings.newBuilder();
+ * settingsBuilder.createReadSessionSettings().getRetrySettings().toBuilder()
+ *     .setTotalTimeout(Duration.ofSeconds(30));
+ * BaseBigQueryStorageSettings settings = settingsBuilder.build();
+ * </code>
+ * </pre>
+ */
+@BetaApi
+public class BigQueryStorageSettings extends ClientSettings<BigQueryStorageSettings> {
+
+  /** Returns the object with the settings used for calls to createReadSession. */
+  public UnaryCallSettings<CreateReadSessionRequest, ReadSession> createReadSessionSettings() {
+    return getTypedStubSettings().createReadSessionSettings();
+  }
+
+  /** Returns the object with the settings used for calls to readRows. */
+  public ServerStreamingCallSettings<ReadRowsRequest, ReadRowsResponse> readRowsSettings() {
+    return getTypedStubSettings().readRowsSettings();
+  }
+
+  /** Returns the object with the settings used for calls to batchCreateReadSessionStreams. */
+  public UnaryCallSettings<
+      BatchCreateReadSessionStreamsRequest, BatchCreateReadSessionStreamsResponse>
+  batchCreateReadSessionStreamsSettings() {
+    return getTypedStubSettings().batchCreateReadSessionStreamsSettings();
+  }
+
+  /** Returns the object with the settings used for calls to finalizeStream. */
+  public UnaryCallSettings<FinalizeStreamRequest, Empty> finalizeStreamSettings() {
+    return getTypedStubSettings().finalizeStreamSettings();
+  }
+
+  /** Returns the object with the settings used for calls to splitReadStream. */
+  public UnaryCallSettings<SplitReadStreamRequest, SplitReadStreamResponse>
+  splitReadStreamSettings() {
+    return getTypedStubSettings().splitReadStreamSettings();
+  }
+
+  EnhancedBigQueryStorageStubSettings getTypedStubSettings() {
+    return (EnhancedBigQueryStorageStubSettings) getStubSettings();
+  }
+
+  public static final BigQueryStorageSettings create(EnhancedBigQueryStorageStubSettings settings)
+      throws IOException {
+    return new BigQueryStorageSettings.Builder(settings.toBuilder()).build();
+  }
+
+  /** Returns a builder for the default ExecutorProvider for this service. */
+  public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
+    return EnhancedBigQueryStorageStubSettings.defaultExecutorProviderBuilder();
+  }
+
+  /** Returns the default service endpoint. */
+  public static String getDefaultEndpoint() {
+    return EnhancedBigQueryStorageStubSettings.getDefaultEndpoint();
+  }
+
+  /** Returns the default service scopes. */
+  public static List<String> getDefaultServiceScopes() {
+    return EnhancedBigQueryStorageStubSettings.getDefaultServiceScopes();
+  }
+
+  /** Returns a builder for the default credentials for this service. */
+  public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
+    return EnhancedBigQueryStorageStubSettings.defaultCredentialsProviderBuilder();
+  }
+
+  /** Returns a builder for the default ChannelProvider for this service. */
+  public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
+    return EnhancedBigQueryStorageStubSettings.defaultGrpcTransportProviderBuilder();
+  }
+
+  public static TransportChannelProvider defaultTransportChannelProvider() {
+    return EnhancedBigQueryStorageStubSettings.defaultTransportChannelProvider();
+  }
+
+  @BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
+  public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
+    return EnhancedBigQueryStorageStubSettings.defaultApiClientHeaderProviderBuilder();
+  }
+
+  /** Returns a new builder for this class. */
+  public static Builder newBuilder() {
+    return Builder.createDefault();
+  }
+
+  /** Returns a new builder for this class. */
+  public static Builder newBuilder(ClientContext clientContext) {
+    return new Builder(clientContext);
+  }
+
+  /** Returns a builder containing all the values of this settings class. */
+  public Builder toBuilder() {
+    return new Builder(this);
+  }
+
+  protected BigQueryStorageSettings(Builder settingsBuilder) throws IOException {
+    super(settingsBuilder);
+  }
+
+  /** Builder for BigQueryStorageSettings. */
+  public static class Builder extends ClientSettings.Builder<BigQueryStorageSettings, Builder> {
+    protected Builder() throws IOException {
+      this((ClientContext) null);
+    }
+
+    protected Builder(ClientContext clientContext) {
+      super(EnhancedBigQueryStorageStubSettings.newBuilder(clientContext));
+    }
+
+    private static Builder createDefault() {
+      return new Builder(EnhancedBigQueryStorageStubSettings.newBuilder());
+    }
+
+    protected Builder(BigQueryStorageSettings settings) {
+      super(settings.getStubSettings().toBuilder());
+    }
+
+    protected Builder(EnhancedBigQueryStorageStubSettings.Builder stubSettings) {
+      super(stubSettings);
+    }
+
+    public EnhancedBigQueryStorageStubSettings.Builder getStubSettingsBuilder() {
+      return ((EnhancedBigQueryStorageStubSettings.Builder) getStubSettings());
+    }
+
+    // NEXT_MAJOR_VER: remove 'throws Exception'
+    /**
+     * Applies the given settings updater function to all of the unary API methods in this service.
+     *
+     * <p>Note: This method does not support applying settings to streaming methods.
+     */
+    public Builder applyToAllUnaryMethods(
+        ApiFunction<UnaryCallSettings.Builder<?, ?>, Void> settingsUpdater) throws Exception {
+      super.applyToAllUnaryMethods(
+          getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
+      return this;
+    }
+
+    /** Returns the builder for the settings used for calls to createReadSession. */
+    public UnaryCallSettings.Builder<CreateReadSessionRequest, ReadSession>
+    createReadSessionSettings() {
+      return getStubSettingsBuilder().createReadSessionSettings();
+    }
+
+    /** Returns the builder for the settings used for calls to readRows. */
+    public ServerStreamingCallSettings.Builder<ReadRowsRequest, ReadRowsResponse>
+    readRowsSettings() {
+      return getStubSettingsBuilder().readRowsSettings();
+    }
+
+    /** Returns the builder for the settings used for calls to batchCreateReadSessionStreams. */
+    public UnaryCallSettings.Builder<
+        BatchCreateReadSessionStreamsRequest, BatchCreateReadSessionStreamsResponse>
+    batchCreateReadSessionStreamsSettings() {
+      return getStubSettingsBuilder().batchCreateReadSessionStreamsSettings();
+    }
+
+    /** Returns the builder for the settings used for calls to finalizeStream. */
+    public UnaryCallSettings.Builder<FinalizeStreamRequest, Empty> finalizeStreamSettings() {
+      return getStubSettingsBuilder().finalizeStreamSettings();
+    }
+
+    /** Returns the builder for the settings used for calls to splitReadStream. */
+    public UnaryCallSettings.Builder<SplitReadStreamRequest, SplitReadStreamResponse>
+    splitReadStreamSettings() {
+      return getStubSettingsBuilder().splitReadStreamSettings();
+    }
+
+    @Override
+    public BigQueryStorageSettings build() throws IOException {
+      return new BigQueryStorageSettings(this);
+    }
+  }
+}