com.google.cloud.bigquery.storage.v1beta2.BigQueryReadSettings Maven / Gradle / Ivy
/*
* Copyright 2020 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.bigquery.storage.v1beta2;
import com.google.api.core.ApiFunction;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.GoogleCredentialsProvider;
import com.google.api.gax.core.InstantiatingExecutorProvider;
import com.google.api.gax.grpc.InstantiatingGrpcChannelProvider;
import com.google.api.gax.rpc.ApiClientHeaderProvider;
import com.google.api.gax.rpc.ClientContext;
import com.google.api.gax.rpc.ClientSettings;
import com.google.api.gax.rpc.ServerStreamingCallSettings;
import com.google.api.gax.rpc.TransportChannelProvider;
import com.google.api.gax.rpc.UnaryCallSettings;
import com.google.cloud.bigquery.storage.v1beta2.stub.EnhancedBigQueryReadStubSettings;
import io.grpc.Metadata;
import io.grpc.Status;
import java.io.IOException;
import java.util.List;
/**
* Settings class to configure an instance of {@link 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();
*
*
*/
@BetaApi
public class BigQueryReadSettings extends ClientSettings {
/** Returns the object with the settings used for calls to createReadSession. */
public UnaryCallSettings createReadSessionSettings() {
return getTypedStubSettings().createReadSessionSettings();
}
/** Returns the object with the settings used for calls to readRows. */
public ServerStreamingCallSettings readRowsSettings() {
return getTypedStubSettings().readRowsSettings();
}
public static interface RetryAttemptListener {
public void onRetryAttempt(Status prevStatus, Metadata prevMetadata);
}
private RetryAttemptListener readRowsRetryAttemptListener = null;
/**
* 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.
*/
public void setReadRowsRetryAttemptListener(RetryAttemptListener readRowsRetryAttemptListener) {
this.readRowsRetryAttemptListener = readRowsRetryAttemptListener;
}
public RetryAttemptListener getReadRowsRetryAttemptListener() {
return readRowsRetryAttemptListener;
}
/** Returns the object with the settings used for calls to splitReadStream. */
public UnaryCallSettings
splitReadStreamSettings() {
return getTypedStubSettings().splitReadStreamSettings();
}
EnhancedBigQueryReadStubSettings getTypedStubSettings() {
return (EnhancedBigQueryReadStubSettings) getStubSettings();
}
public static final BigQueryReadSettings create(EnhancedBigQueryReadStubSettings stub)
throws IOException {
return new BigQueryReadSettings.Builder(stub.toBuilder()).build();
}
/** Returns a builder for the default ExecutorProvider for this service. */
public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder() {
return EnhancedBigQueryReadStubSettings.defaultExecutorProviderBuilder();
}
/** Returns the default service endpoint. */
public static String getDefaultEndpoint() {
return EnhancedBigQueryReadStubSettings.getDefaultEndpoint();
}
/** Returns the default service scopes. */
public static List getDefaultServiceScopes() {
return EnhancedBigQueryReadStubSettings.getDefaultServiceScopes();
}
/** Returns a builder for the default credentials for this service. */
public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder() {
return EnhancedBigQueryReadStubSettings.defaultCredentialsProviderBuilder();
}
/** Returns a builder for the default ChannelProvider for this service. */
public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder() {
return EnhancedBigQueryReadStubSettings.defaultGrpcTransportProviderBuilder();
}
public static TransportChannelProvider defaultTransportChannelProvider() {
return EnhancedBigQueryReadStubSettings.defaultTransportChannelProvider();
}
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder() {
return EnhancedBigQueryReadStubSettings.defaultApiClientHeaderProviderBuilder();
}
/** Returns a new builder for this class. */
public static Builder newBuilder() {
return Builder.createDefault();
}
/** Returns a new builder for this class. */
public static Builder newBuilder(ClientContext clientContext) {
return new Builder(clientContext);
}
/** Returns a builder containing all the values of this settings class. */
public Builder toBuilder() {
return new Builder(this);
}
protected BigQueryReadSettings(Builder settingsBuilder) throws IOException {
super(settingsBuilder);
}
/** Builder for BigQueryReadSettings. */
public static class Builder extends ClientSettings.Builder {
protected Builder() throws IOException {
this((ClientContext) null);
}
protected Builder(ClientContext clientContext) {
super(EnhancedBigQueryReadStubSettings.newBuilder(clientContext));
}
private static Builder createDefault() {
return new Builder(EnhancedBigQueryReadStubSettings.newBuilder());
}
protected Builder(BigQueryReadSettings settings) {
super(settings.getStubSettings().toBuilder());
}
protected Builder(EnhancedBigQueryReadStubSettings.Builder stubSettings) {
super(stubSettings);
}
public EnhancedBigQueryReadStubSettings.Builder getStubSettingsBuilder() {
return ((EnhancedBigQueryReadStubSettings.Builder) getStubSettings());
}
// NEXT_MAJOR_VER: remove 'throws Exception'
/**
* Applies the given settings updater function to all of the unary API methods in this service.
*
* Note: This method does not support applying settings to streaming methods.
*/
public Builder applyToAllUnaryMethods(
ApiFunction, Void> settingsUpdater) throws Exception {
super.applyToAllUnaryMethods(
getStubSettingsBuilder().unaryMethodSettingsBuilders(), settingsUpdater);
return this;
}
private RetryAttemptListener readRowsRetryAttemptListener = null;
public Builder setReadRowsRetryAttemptListener(
RetryAttemptListener readRowsRetryAttemptListener) {
this.readRowsRetryAttemptListener = readRowsRetryAttemptListener;
return this;
}
/** Returns the builder for the settings used for calls to createReadSession. */
public UnaryCallSettings.Builder
createReadSessionSettings() {
return getStubSettingsBuilder().createReadSessionSettings();
}
/** Returns the builder for the settings used for calls to readRows. */
public ServerStreamingCallSettings.Builder
readRowsSettings() {
return getStubSettingsBuilder().readRowsSettings();
}
/** Returns the builder for the settings used for calls to splitReadStream. */
public UnaryCallSettings.Builder
splitReadStreamSettings() {
return getStubSettingsBuilder().splitReadStreamSettings();
}
@Override
public BigQueryReadSettings build() throws IOException {
BigQueryReadSettings settings = new BigQueryReadSettings(this);
settings.setReadRowsRetryAttemptListener(readRowsRetryAttemptListener);
return settings;
}
}
}