Class BigQueryStorageSettings (3.17.1)
Version 3.17.1keyboard_arrow_down
Beta
This library is covered by the Pre-GA Offerings Terms
of the Terms of Service. Pre-GA libraries might have limited support,
and changes to pre-GA libraries might not be compatible with other pre-GA versions.
For more information, see the
launch stage descriptions .
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();
Static Methods
create(EnhancedBigQueryStorageStubSettings settings)
public static final BigQueryStorageSettings create ( EnhancedBigQueryStorageStubSettings settings )
public static ApiClientHeaderProvider . Builder defaultApiClientHeaderProviderBuilder ()
Beta
The surface for customizing headers is not stable yet and may change in the future.
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider . Builder defaultCredentialsProviderBuilder ()
Returns a builder for the default credentials for this service.
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider . Builder defaultExecutorProviderBuilder ()
Returns a builder for the default ExecutorProvider for this service.
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider . Builder defaultGrpcTransportProviderBuilder ()
Returns a builder for the default ChannelProvider for this service.
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider ()
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.
newBuilder()
public static BigQueryStorageSettings . Builder newBuilder ()
Returns a new builder for this class.
newBuilder(ClientContext clientContext)
public static BigQueryStorageSettings . Builder newBuilder ( ClientContext clientContext )
Returns a new builder for this class.
Constructors
BigQueryStorageSettings(BigQueryStorageSettings.Builder settingsBuilder)
protected BigQueryStorageSettings ( BigQueryStorageSettings . Builder settingsBuilder )
Methods
batchCreateReadSessionStreamsSettings()
public UnaryCallSettings<Storage . BatchCreateReadSessionStreamsRequest , Storage . BatchCreateReadSessionStreamsResponse > batchCreateReadSessionStreamsSettings ()
Returns the object with the settings used for calls to batchCreateReadSessionStreams.
createReadSessionSettings()
public UnaryCallSettings<Storage . CreateReadSessionRequest , Storage . ReadSession > createReadSessionSettings ()
Returns the object with the settings used for calls to createReadSession.
finalizeStreamSettings()
public UnaryCallSettings<Storage . FinalizeStreamRequest , Empty > finalizeStreamSettings ()
Returns the object with the settings used for calls to finalizeStream.
getReadRowsRetryAttemptListener()
public BigQueryStorageSettings . RetryAttemptListener getReadRowsRetryAttemptListener ()
readRowsSettings()
public ServerStreamingCallSettings<Storage . ReadRowsRequest , Storage . ReadRowsResponse > readRowsSettings ()
Returns the object with the settings used for calls to readRows.
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.
splitReadStreamSettings()
public UnaryCallSettings<Storage . SplitReadStreamRequest , Storage . SplitReadStreamResponse > splitReadStreamSettings ()
Returns the object with the settings used for calls to splitReadStream.
toBuilder()
public BigQueryStorageSettings . Builder toBuilder ()
Returns a builder containing all the values of this settings class.
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-30 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-30 UTC."],[],[]]
