com.google.cloud.bigquery.storage.v1alpha2

Class BigQueryWriteSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<BigQueryWriteSettings>

com.google.cloud.bigquery.storage.v1alpha2.BigQueryWriteSettings

@Generated(value="by gapic-generator")
 @BetaApi
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:

 
 BigQueryWriteSettings.Builder bigQueryWriteSettingsBuilder =
     BigQueryWriteSettings.newBuilder();
 bigQueryWriteSettingsBuilder
     .createWriteStreamSettings()
     .setRetrySettings(
         bigQueryWriteSettingsBuilder.createWriteStreamSettings().getRetrySettings().toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 BigQueryWriteSettings bigQueryWriteSettings = bigQueryWriteSettingsBuilder.build();
 
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BigQueryWriteSettings.Builder Builder for BigQueryWriteSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	BigQueryWriteSettings(BigQueryWriteSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
com.google.api.gax.rpc.StreamingCallSettings<Storage.AppendRowsRequest,Storage.AppendRowsResponse>	appendRowsSettings() Returns the object with the settings used for calls to appendRows.
com.google.api.gax.rpc.UnaryCallSettings<Storage.BatchCommitWriteStreamsRequest,Storage.BatchCommitWriteStreamsResponse>	batchCommitWriteStreamsSettings() Returns the object with the settings used for calls to batchCommitWriteStreams.
static BigQueryWriteSettings	create(BigQueryWriteStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<Storage.CreateWriteStreamRequest,Stream.WriteStream>	createWriteStreamSettings() Returns the object with the settings used for calls to createWriteStream.
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.FinalizeWriteStreamRequest,Storage.FinalizeWriteStreamResponse>	finalizeWriteStreamSettings() Returns the object with the settings used for calls to finalizeWriteStream.
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<Storage.GetWriteStreamRequest,Stream.WriteStream>	getWriteStreamSettings() Returns the object with the settings used for calls to getWriteStream.
static BigQueryWriteSettings.Builder	newBuilder() Returns a new builder for this class.
static BigQueryWriteSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
BigQueryWriteSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.ClientSettings

getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getStubSettings, getTransportChannelProvider, getWatchdogCheckInterval, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BigQueryWriteSettings

protected BigQueryWriteSettings(BigQueryWriteSettings.Builder settingsBuilder)
                         throws IOException

Throws:

IOException

Method Detail

createWriteStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.CreateWriteStreamRequest,Stream.WriteStream> createWriteStreamSettings()

Returns the object with the settings used for calls to createWriteStream.

appendRowsSettings

public com.google.api.gax.rpc.StreamingCallSettings<Storage.AppendRowsRequest,Storage.AppendRowsResponse> appendRowsSettings()

Returns the object with the settings used for calls to appendRows.

getWriteStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.GetWriteStreamRequest,Stream.WriteStream> getWriteStreamSettings()

Returns the object with the settings used for calls to getWriteStream.

finalizeWriteStreamSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.FinalizeWriteStreamRequest,Storage.FinalizeWriteStreamResponse> finalizeWriteStreamSettings()

Returns the object with the settings used for calls to finalizeWriteStream.

batchCommitWriteStreamsSettings

public com.google.api.gax.rpc.UnaryCallSettings<Storage.BatchCommitWriteStreamsRequest,Storage.BatchCommitWriteStreamsResponse> batchCommitWriteStreamsSettings()

Returns the object with the settings used for calls to batchCommitWriteStreams.

create

public static final BigQueryWriteSettings create(BigQueryWriteStubSettings 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(value="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 BigQueryWriteSettings.Builder 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

public BigQueryWriteSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<BigQueryWriteSettings>