Class BaseBigQueryStorageSettings
- java.lang.Object
-
- com.google.api.gax.rpc.ClientSettings<BaseBigQueryStorageSettings>
-
- com.google.cloud.bigquery.storage.v1beta1.BaseBigQueryStorageSettings
-
@BetaApi @Generated("by gapic-generator-java") public class BaseBigQueryStorageSettings extends com.google.api.gax.rpc.ClientSettings<BaseBigQueryStorageSettings>
Settings class to configure an instance ofBaseBigQueryStorageClient
.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:
// This snippet has been automatically generated and should be regarded as a code template only. // It will require modifications to work: // - It may require correct/in-range values for request initialization. // - It may require specifying regional endpoints when creating the service client as shown in // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library BaseBigQueryStorageSettings.Builder baseBigQueryStorageSettingsBuilder = BaseBigQueryStorageSettings.newBuilder(); baseBigQueryStorageSettingsBuilder .createReadSessionSettings() .setRetrySettings( baseBigQueryStorageSettingsBuilder .createReadSessionSettings() .getRetrySettings() .toBuilder() .setTotalTimeout(Duration.ofSeconds(30)) .build()); BaseBigQueryStorageSettings baseBigQueryStorageSettings = baseBigQueryStorageSettingsBuilder.build();
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BaseBigQueryStorageSettings.Builder
Builder for BaseBigQueryStorageSettings.
-
Constructor Summary
Constructors Modifier Constructor Description protected
BaseBigQueryStorageSettings(BaseBigQueryStorageSettings.Builder settingsBuilder)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.google.api.gax.rpc.UnaryCallSettings<Storage.BatchCreateReadSessionStreamsRequest,Storage.BatchCreateReadSessionStreamsResponse>
batchCreateReadSessionStreamsSettings()
Returns the object with the settings used for calls to batchCreateReadSessionStreams.static BaseBigQueryStorageSettings
create(BigQueryStorageStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<Storage.CreateReadSessionRequest,Storage.ReadSession>
createReadSessionSettings()
Returns the object with the settings used for calls to createReadSession.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
defaultGrpcTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
defaultTransportChannelProvider()
com.google.api.gax.rpc.UnaryCallSettings<Storage.FinalizeStreamRequest,com.google.protobuf.Empty>
finalizeStreamSettings()
Returns the object with the settings used for calls to finalizeStream.static String
getDefaultEndpoint()
Returns the default service endpoint.static List<String>
getDefaultServiceScopes()
Returns the default service scopes.static BaseBigQueryStorageSettings.Builder
newBuilder()
Returns a new builder for this class.static BaseBigQueryStorageSettings.Builder
newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.com.google.api.gax.rpc.ServerStreamingCallSettings<Storage.ReadRowsRequest,Storage.ReadRowsResponse>
readRowsSettings()
Returns the object with the settings used for calls to readRows.com.google.api.gax.rpc.UnaryCallSettings<Storage.SplitReadStreamRequest,Storage.SplitReadStreamResponse>
splitReadStreamSettings()
Returns the object with the settings used for calls to splitReadStream.BaseBigQueryStorageSettings.Builder
toBuilder()
Returns a builder containing all the values of this settings class.-
Methods inherited from class com.google.api.gax.rpc.ClientSettings
getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString
-
-
-
-
Constructor Detail
-
BaseBigQueryStorageSettings
protected BaseBigQueryStorageSettings(BaseBigQueryStorageSettings.Builder settingsBuilder) throws IOException
- Throws:
IOException
-
-
Method Detail
-
createReadSessionSettings
public com.google.api.gax.rpc.UnaryCallSettings<Storage.CreateReadSessionRequest,Storage.ReadSession> createReadSessionSettings()
Returns the object with the settings used for calls to createReadSession.
-
readRowsSettings
public com.google.api.gax.rpc.ServerStreamingCallSettings<Storage.ReadRowsRequest,Storage.ReadRowsResponse> readRowsSettings()
Returns the object with the settings used for calls to readRows.
-
batchCreateReadSessionStreamsSettings
public com.google.api.gax.rpc.UnaryCallSettings<Storage.BatchCreateReadSessionStreamsRequest,Storage.BatchCreateReadSessionStreamsResponse> batchCreateReadSessionStreamsSettings()
Returns the object with the settings used for calls to batchCreateReadSessionStreams.
-
finalizeStreamSettings
public com.google.api.gax.rpc.UnaryCallSettings<Storage.FinalizeStreamRequest,com.google.protobuf.Empty> finalizeStreamSettings()
Returns the object with the settings used for calls to finalizeStream.
-
splitReadStreamSettings
public com.google.api.gax.rpc.UnaryCallSettings<Storage.SplitReadStreamRequest,Storage.SplitReadStreamResponse> splitReadStreamSettings()
Returns the object with the settings used for calls to splitReadStream.
-
create
public static final BaseBigQueryStorageSettings create(BigQueryStorageStubSettings stub) throws IOException
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
Returns a builder for the default ExecutorProvider for this service.
-
getDefaultEndpoint
public static String getDefaultEndpoint()
Returns the default service endpoint.
-
getDefaultServiceScopes
public static List<String> getDefaultServiceScopes()
Returns the default service scopes.
-
defaultCredentialsProviderBuilder
public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
Returns a builder for the default credentials for this service.
-
defaultGrpcTransportProviderBuilder
public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
Returns a builder for the default ChannelProvider for this service.
-
defaultTransportChannelProvider
public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()
-
defaultApiClientHeaderProviderBuilder
@BetaApi("The surface for customizing headers is not stable yet and may change in the future.") public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
-
newBuilder
public static BaseBigQueryStorageSettings.Builder newBuilder()
Returns a new builder for this class.
-
newBuilder
public static BaseBigQueryStorageSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
Returns a new builder for this class.
-
toBuilder
public BaseBigQueryStorageSettings.Builder toBuilder()
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<BaseBigQueryStorageSettings>
-
-