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)
Parameter
Returns
Exceptions
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
defaultCredentialsProviderBuilder()
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
Returns
defaultExecutorProviderBuilder()
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
Returns
defaultGrpcTransportProviderBuilder()
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.
Returns
defaultTransportChannelProvider()
public static TransportChannelProvider defaultTransportChannelProvider()
Returns
getDefaultEndpoint()
public static String getDefaultEndpoint()
Returns the default service endpoint.
Returns
getDefaultServiceScopes()
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
Returns
newBuilder()
public static BigQueryReadSettings.Builder newBuilder()
Returns a new builder for this class.
Returns
newBuilder(ClientContext clientContext)
public static BigQueryReadSettings.Builder newBuilder(ClientContext clientContext)
Returns a new builder for this class.
Parameter
Returns
Constructors
BigQueryReadSettings(BigQueryReadSettings.Builder settingsBuilder)
protected BigQueryReadSettings(BigQueryReadSettings.Builder settingsBuilder)
Parameter
Methods
createReadSessionSettings()
public UnaryCallSettings<CreateReadSessionRequest,ReadSession> createReadSessionSettings()
Returns the object with the settings used for calls to createReadSession.
Returns
getReadRowsRetryAttemptListener()
public BigQueryReadSettings.RetryAttemptListener getReadRowsRetryAttemptListener()
Returns
readRowsSettings()
public ServerStreamingCallSettings<ReadRowsRequest,ReadRowsResponse> readRowsSettings()
Returns the object with the settings used for calls to readRows.
Returns
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.
Parameter
splitReadStreamSettings()
public UnaryCallSettings<SplitReadStreamRequest,SplitReadStreamResponse> splitReadStreamSettings()
Returns the object with the settings used for calls to splitReadStream.
Returns
toBuilder()
public BigQueryReadSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.
Returns
Overrides