Package com.google.cloud.bigquery.storage.v1

Class BigQueryReadSettings

java.lang.Object
com.google.api.gax.rpc.ClientSettings<BigQueryReadSettings>
com.google.cloud.bigquery.storage.v1.BigQueryReadSettings
@BetaApi public class BigQueryReadSettings extends com.google.api.gax.rpc.ClientSettings<BigQueryReadSettings>
Settings class to configure an instance of BigQueryReadClient.

The default instance has everything set to sensible defaults:

  • The default service address (bigquerystorage.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

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: 

 
 BigQueryReadSettings.Builder BigQueryReadSettingsBuilder =
     BigQueryReadSettings.newBuilder();
 BigQueryReadSettingsBuilder.createReadSessionSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 BigQueryReadSettings BigQueryReadSettings = BigQueryReadSettingsBuilder.build();

  • Constructor Details

  • Method Details

    • createReadSessionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateReadSessionRequest,ReadSession> createReadSessionSettings()
      Returns the object with the settings used for calls to createReadSession.

    • readRowsSettings

      public com.google.api.gax.rpc.ServerStreamingCallSettings<ReadRowsRequest,ReadRowsResponse> readRowsSettings()
      Returns the object with the settings used for calls to readRows.

    • setReadRowsRetryAttemptListener

      public void setReadRowsRetryAttemptListener(BigQueryReadSettings.RetryAttemptListener readRowsRetryAttemptListener)
      If a non null readRowsRetryAttemptListener is provided, client will call onRetryAttempt function before a failed ReadRows request is retried. This can be used as negative feedback mechanism for future decision to split read streams because some retried failures are due to resource exhaustion that increased parallelism only makes it worse.

    • getReadRowsRetryAttemptListener

      public BigQueryReadSettings.RetryAttemptListener getReadRowsRetryAttemptListener()

    • splitReadStreamSettings

      public com.google.api.gax.rpc.UnaryCallSettings<SplitReadStreamRequest,SplitReadStreamResponse> splitReadStreamSettings()
      Returns the object with the settings used for calls to splitReadStream.

    • create

      public static final BigQueryReadSettings create(EnhancedBigQueryReadStubSettings stub) throws IOException
      Throws:
      IOException

    • defaultExecutorProviderBuilder

      public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
      Returns a builder for the default ExecutorProvider for this service.

    • getDefaultEndpoint

      public static String getDefaultEndpoint()
      Returns the default service endpoint.

    • getDefaultServiceScopes

      public static List<String> getDefaultServiceScopes()
      Returns the default service scopes.

    • defaultCredentialsProviderBuilder

      public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
      Returns a builder for the default credentials for this service.

    • defaultGrpcTransportProviderBuilder

      public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
      Returns a builder for the default ChannelProvider for this service.

    • defaultTransportChannelProvider

      public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

    • defaultApiClientHeaderProviderBuilder

      @BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

    • newBuilder

      public static BigQueryReadSettings.Builder newBuilder()
      Returns a new builder for this class.

    • newBuilder

      public static BigQueryReadSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
      Returns a new builder for this class.

    • toBuilder

      public BigQueryReadSettings.Builder toBuilder()
      Returns a builder containing all the values of this settings class.
      Specified by:
      toBuilder in class com.google.api.gax.rpc.ClientSettings<BigQueryReadSettings>