public class BigQueryReadSettings extends 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();
Static Methods
create(EnhancedBigQueryReadStubSettings stub)
public static final BigQueryReadSettings create(EnhancedBigQueryReadStubSettings stub)
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
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.
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
newBuilder()
public static BigQueryReadSettings.Builder newBuilder()
Returns a new builder for this class.
newBuilder(ClientContext clientContext)
public static BigQueryReadSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Constructors
BigQueryReadSettings(BigQueryReadSettings.Builder settingsBuilder)
protected BigQueryReadSettings(BigQueryReadSettings.Builder settingsBuilder)
Methods
createReadSessionSettings()
public UnaryCallSettings<CreateReadSessionRequest,ReadSession> createReadSessionSettings()
Returns the object with the settings used for calls to createReadSession.
getReadRowsRetryAttemptListener()
public BigQueryReadSettings.RetryAttemptListener getReadRowsRetryAttemptListener()
readRowsSettings()
public ServerStreamingCallSettings<ReadRowsRequest,ReadRowsResponse> readRowsSettings()
Returns the object with the settings used for calls to readRows.
setReadRowsRetryAttemptListener(BigQueryReadSettings.RetryAttemptListener readRowsRetryAttemptListener)
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.
splitReadStreamSettings()
public UnaryCallSettings<SplitReadStreamRequest,SplitReadStreamResponse> splitReadStreamSettings()
Returns the object with the settings used for calls to splitReadStream.
toBuilder()
public BigQueryReadSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
