Class BigQueryWriteSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<BigQueryWriteSettings>
com.google.cloud.bigquery.storage.v1.BigQueryWriteSettings
@Generated("by gapic-generator-java")
public class BigQueryWriteSettings
extends com.google.api.gax.rpc.ClientSettings<BigQueryWriteSettings>
Settings class to configure an instance of
BigQueryWriteClient
.
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 createWriteStream 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
BigQueryWriteSettings.Builder bigQueryWriteSettingsBuilder = BigQueryWriteSettings.newBuilder();
bigQueryWriteSettingsBuilder
.createWriteStreamSettings()
.setRetrySettings(
bigQueryWriteSettingsBuilder
.createWriteStreamSettings()
.getRetrySettings()
.toBuilder()
.setTotalTimeout(Duration.ofSeconds(30))
.build());
BigQueryWriteSettings bigQueryWriteSettings = bigQueryWriteSettingsBuilder.build();
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic class
Builder for BigQueryWriteSettings. -
Constructor Summary
ModifierConstructorDescriptionprotected
BigQueryWriteSettings
(BigQueryWriteSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptioncom.google.api.gax.rpc.StreamingCallSettings<AppendRowsRequest,
AppendRowsResponse> Returns the object with the settings used for calls to appendRows.com.google.api.gax.rpc.UnaryCallSettings<BatchCommitWriteStreamsRequest,
BatchCommitWriteStreamsResponse> Returns the object with the settings used for calls to batchCommitWriteStreams.static final BigQueryWriteSettings
com.google.api.gax.rpc.UnaryCallSettings<CreateWriteStreamRequest,
WriteStream> Returns the object with the settings used for calls to createWriteStream.static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder
static com.google.api.gax.core.GoogleCredentialsProvider.Builder
Returns a builder for the default credentials for this service.static com.google.api.gax.core.InstantiatingExecutorProvider.Builder
Returns a builder for the default ExecutorProvider for this service.static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder
Returns a builder for the default ChannelProvider for this service.static com.google.api.gax.rpc.TransportChannelProvider
com.google.api.gax.rpc.UnaryCallSettings<FinalizeWriteStreamRequest,
FinalizeWriteStreamResponse> Returns the object with the settings used for calls to finalizeWriteStream.com.google.api.gax.rpc.UnaryCallSettings<FlushRowsRequest,
FlushRowsResponse> Returns the object with the settings used for calls to flushRows.static String
Returns the default service endpoint.Returns the default service scopes.com.google.api.gax.rpc.UnaryCallSettings<GetWriteStreamRequest,
WriteStream> Returns the object with the settings used for calls to getWriteStream.Returns a new builder for this class.newBuilder
(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.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 Details
-
BigQueryWriteSettings
- Throws:
IOException
-
-
Method Details
-
createWriteStreamSettings
public com.google.api.gax.rpc.UnaryCallSettings<CreateWriteStreamRequest,WriteStream> createWriteStreamSettings()Returns the object with the settings used for calls to createWriteStream. -
appendRowsSettings
public com.google.api.gax.rpc.StreamingCallSettings<AppendRowsRequest,AppendRowsResponse> appendRowsSettings()Returns the object with the settings used for calls to appendRows. -
getWriteStreamSettings
public com.google.api.gax.rpc.UnaryCallSettings<GetWriteStreamRequest,WriteStream> getWriteStreamSettings()Returns the object with the settings used for calls to getWriteStream. -
finalizeWriteStreamSettings
public com.google.api.gax.rpc.UnaryCallSettings<FinalizeWriteStreamRequest,FinalizeWriteStreamResponse> finalizeWriteStreamSettings()Returns the object with the settings used for calls to finalizeWriteStream. -
batchCommitWriteStreamsSettings
public com.google.api.gax.rpc.UnaryCallSettings<BatchCommitWriteStreamsRequest,BatchCommitWriteStreamsResponse> batchCommitWriteStreamsSettings()Returns the object with the settings used for calls to batchCommitWriteStreams. -
flushRowsSettings
public com.google.api.gax.rpc.UnaryCallSettings<FlushRowsRequest,FlushRowsResponse> flushRowsSettings()Returns the object with the settings used for calls to flushRows. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
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
Returns a new builder for this class. -
newBuilder
public static BigQueryWriteSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilder
in classcom.google.api.gax.rpc.ClientSettings<BigQueryWriteSettings>
-