Class BigQueryStorageSettings (3.6.0)

public class BigQueryStorageSettings extends 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();
 
 

Inheritance

java.lang.Object > ClientSettings > BigQueryStorageSettings

Static Methods

create(EnhancedBigQueryStorageStubSettings settings)

public static final BigQueryStorageSettings create(EnhancedBigQueryStorageStubSettings settings)
Parameter
Name Description
settings EnhancedBigQueryStorageStubSettings
Returns
Type Description
BigQueryStorageSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static BigQueryStorageSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
BigQueryStorageSettings.Builder

newBuilder(ClientContext clientContext)

public static BigQueryStorageSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
BigQueryStorageSettings.Builder

Constructors

BigQueryStorageSettings(BigQueryStorageSettings.Builder settingsBuilder)

protected BigQueryStorageSettings(BigQueryStorageSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder BigQueryStorageSettings.Builder

Methods

batchCreateReadSessionStreamsSettings()

public UnaryCallSettings<Storage.BatchCreateReadSessionStreamsRequest,Storage.BatchCreateReadSessionStreamsResponse> batchCreateReadSessionStreamsSettings()

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

Returns
Type Description
UnaryCallSettings<BatchCreateReadSessionStreamsRequest,BatchCreateReadSessionStreamsResponse>

createReadSessionSettings()

public UnaryCallSettings<Storage.CreateReadSessionRequest,Storage.ReadSession> createReadSessionSettings()

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

Returns
Type Description
UnaryCallSettings<CreateReadSessionRequest,ReadSession>

finalizeStreamSettings()

public UnaryCallSettings<Storage.FinalizeStreamRequest,Empty> finalizeStreamSettings()

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

Returns
Type Description
UnaryCallSettings<FinalizeStreamRequest,Empty>

getReadRowsRetryAttemptListener()

public BigQueryStorageSettings.RetryAttemptListener getReadRowsRetryAttemptListener()
Returns
Type Description
BigQueryStorageSettings.RetryAttemptListener

readRowsSettings()

public ServerStreamingCallSettings<Storage.ReadRowsRequest,Storage.ReadRowsResponse> readRowsSettings()

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

Returns
Type Description
ServerStreamingCallSettings<ReadRowsRequest,ReadRowsResponse>

setReadRowsRetryAttemptListener(BigQueryStorageSettings.RetryAttemptListener readRowsRetryAttemptListener)

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.

Parameter
Name Description
readRowsRetryAttemptListener BigQueryStorageSettings.RetryAttemptListener

splitReadStreamSettings()

public UnaryCallSettings<Storage.SplitReadStreamRequest,Storage.SplitReadStreamResponse> splitReadStreamSettings()

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

Returns
Type Description
UnaryCallSettings<SplitReadStreamRequest,SplitReadStreamResponse>

toBuilder()

public BigQueryStorageSettings.Builder toBuilder()

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

Returns
Type Description
BigQueryStorageSettings.Builder
Overrides