com.google.cloud.bigquery.storage.v1beta1

Class BigQueryStorageSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<BigQueryStorageSettings>

com.google.cloud.bigquery.storage.v1beta1.BigQueryStorageSettings

@BetaApi
public class BigQueryStorageSettings
extends com.google.api.gax.rpc.ClientSettings<BigQueryStorageSettings>

Settings class to configure an instance of BigQueryStorageClient.

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:

 
 BigQueryStorageSettings.Builder settingsBuilder = BaseBigQueryStorageSettings.newBuilder();
 settingsBuilder.createReadSessionSettings().getRetrySettings().toBuilder()
     .setTotalTimeout(Duration.ofSeconds(30));
 BaseBigQueryStorageSettings settings = settingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigQueryStorageSettings.Builder Builder for BigQueryStorageSettings.
static interface	BigQueryStorageSettings.RetryAttemptListener

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BigQueryStorageSettings(BigQueryStorageSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.UnaryCallSettings<Storage.BatchCreateReadSessionStreamsRequest,Storage.BatchCreateReadSessionStreamsResponse>	batchCreateReadSessionStreamsSettings() Returns the object with the settings used for calls to batchCreateReadSessionStreams.
static BigQueryStorageSettings	create(EnhancedBigQueryStorageStubSettings settings)
com.google.api.gax.rpc.UnaryCallSettings<Storage.CreateReadSessionRequest,Storage.ReadSession>	createReadSessionSettings() Returns the object with the settings used for calls to createReadSession.
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<Storage.FinalizeStreamRequest,com.google.protobuf.Empty>	finalizeStreamSettings() Returns the object with the settings used for calls to finalizeStream.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
BigQueryStorageSettings.RetryAttemptListener	getReadRowsRetryAttemptListener()
static BigQueryStorageSettings.Builder	newBuilder() Returns a new builder for this class.
static BigQueryStorageSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.ServerStreamingCallSettings<Storage.ReadRowsRequest,Storage.ReadRowsResponse>	readRowsSettings() Returns the object with the settings used for calls to readRows.
void	setReadRowsRetryAttemptListener(BigQueryStorageSettings.RetryAttemptListener readRowsRetryAttemptListener) If a non null readRowsRetryAttemptListener is provided, client will call onRetryAttempt function before a failed ReadRows request is retried.
com.google.api.gax.rpc.UnaryCallSettings<Storage.SplitReadStreamRequest,Storage.SplitReadStreamResponse>	splitReadStreamSettings() Returns the object with the settings used for calls to splitReadStream.
BigQueryStorageSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BigQueryStorageSettings

protected BigQueryStorageSettings(BigQueryStorageSettings.Builder settingsBuilder)
                           throws IOException

Throws:

IOException

Method Detail

createReadSessionSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.CreateReadSessionRequest,Storage.ReadSession> createReadSessionSettings()

Returns the object with the settings used for calls to createReadSession.

readRowsSettings

public com.google.api.gax.rpc.ServerStreamingCallSettings<Storage.ReadRowsRequest,Storage.ReadRowsResponse> readRowsSettings()

Returns the object with the settings used for calls to readRows.

setReadRowsRetryAttemptListener

public void setReadRowsRetryAttemptListener(BigQueryStorageSettings.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 BigQueryStorageSettings.RetryAttemptListener getReadRowsRetryAttemptListener()

batchCreateReadSessionStreamsSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.BatchCreateReadSessionStreamsRequest,Storage.BatchCreateReadSessionStreamsResponse> batchCreateReadSessionStreamsSettings()

Returns the object with the settings used for calls to batchCreateReadSessionStreams.

finalizeStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.FinalizeStreamRequest,com.google.protobuf.Empty> finalizeStreamSettings()

Returns the object with the settings used for calls to finalizeStream.

splitReadStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.SplitReadStreamRequest,Storage.SplitReadStreamResponse> splitReadStreamSettings()

Returns the object with the settings used for calls to splitReadStream.

create

public static final BigQueryStorageSettings create(EnhancedBigQueryStorageStubSettings settings)
                                            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(value="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 BigQueryStorageSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static BigQueryStorageSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public BigQueryStorageSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<BigQueryStorageSettings>