Package com.google.cloud.spanner

Class SpannerOptions.Builder

java.lang.Object

com.google.cloud.ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

com.google.cloud.spanner.SpannerOptions.Builder

Enclosing class:

SpannerOptions

public static class SpannerOptions.Builder
extends ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

Builder for SpannerOptions instances.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpannerOptions.Builder.DefaultReadWriteTransactionOptions	Provides the default read-write transaction options for all databases.

Field Summary

Fields inherited from class com.google.cloud.ServiceOptions.Builder

credentials

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder()

Method Summary

Modifier and Type	Method	Description
SpannerOptions	build()
SpannerOptions.Builder	disableAdministrativeRequestRetries()	Disables automatic retries of administrative requests that fail if the https://cloud.google.com/spanner/quotas#administrative_limits have been exceeded.
SpannerOptions.Builder	disableDirectPath()	Deprecated.
SpannerOptions.Builder	disableDynamicChannelPool()	Disables dynamic channel pooling.
SpannerOptions.Builder	disableGrpcGcpExtension()	Disables gRPC-GCP extension and uses GAX channel pool instead.
SpannerOptions.Builder	disableLeaderAwareRouting()	Disable leader aware routing.
SpannerOptions.Builder	enableDynamicChannelPool()	Enables dynamic channel pooling.
SpannerOptions.Builder	enableGrpcGcpExtension()	Enables gRPC-GCP extension with the default settings.
SpannerOptions.Builder	enableGrpcGcpExtension(GcpManagedChannelOptions options)	Enables gRPC-GCP extension and uses provided options for configuration.
SpannerOptions.Builder	enableLeaderAwareRouting()	Enable leader aware routing.
protected Set<String>	getAllowedClientLibTokens()
DatabaseAdminStubSettings.Builder	getDatabaseAdminStubSettingsBuilder()	Returns the DatabaseAdminStubSettings.Builder that will be used to build the SpannerRpc.
InstanceAdminStubSettings.Builder	getInstanceAdminStubSettingsBuilder()	Returns the InstanceAdminStubSettings.Builder that will be used to build the SpannerRpc.
SpannerStubSettings.Builder	getSpannerStubSettingsBuilder()	Returns the SpannerStubSettings.Builder that will be used to build the SpannerRpc.
SpannerOptions.Builder	setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider provider)	Sets the ExecutorProvider to use for high-level async calls that need an executor, such as fetching results for an AsyncResultSet.
SpannerOptions.Builder	setAutoThrottleAdministrativeRequests()	Instructs the client library to automatically throttle the number of administrative requests if the rate of administrative requests generated by this Spanner instance will exceed the administrative limits Cloud Spanner.
SpannerOptions.Builder	setBuiltInMetricsEnabled(boolean enableBuiltInMetrics)	Sets whether to enable or disable built in metrics for Data client operations.
SpannerOptions.Builder	setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider callCredentialsProvider)	Sets a SpannerOptions.CallCredentialsProvider that can deliver CallCredentials to use on a per-gRPC basis.
SpannerOptions.Builder	setChannelConfigurator(ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder> channelConfigurator)	Sets an ApiFunction that will be used to configure the transport channel.
SpannerOptions.Builder	setChannelEndpointCacheFactory(ChannelEndpointCacheFactory channelEndpointCacheFactory)
SpannerOptions.Builder	setChannelProvider(TransportChannelProvider channelProvider)	Sets the ChannelProvider.
SpannerOptions.Builder	setClientLibToken(String clientLibToken)
SpannerOptions.Builder	setCompressorName(String compressorName)	Sets the compression to use for all gRPC calls.
SpannerOptions.Builder	setDatabaseRole(String databaseRole)	Sets the database role that should be used for connections that are created by this instance.
SpannerOptions.Builder	setDecodeMode(DecodeMode decodeMode)	Specifies how values that are returned from a query should be decoded and converted from protobuf values into plain Java objects.
SpannerOptions.Builder	setDefaultClientContext(RequestOptions.ClientContext clientContext)	Sets the default RequestOptions.ClientContext for all requests.
SpannerOptions.Builder	setDefaultQueryOptions(DatabaseId database, ExecuteSqlRequest.QueryOptions defaultQueryOptions)	Sets the default ExecuteSqlRequest.QueryOptions that will be used for all queries on the specified database.
SpannerOptions.Builder	setDefaultTransactionOptions(SpannerOptions.Builder.DefaultReadWriteTransactionOptions defaultReadWriteTransactionOptions)	Sets the SpannerOptions.Builder.DefaultReadWriteTransactionOptions for read-write transactions.
SpannerOptions.Builder	setDirectedReadOptions(DirectedReadOptions directedReadOptions)	Sets the Options.DirectedReadOption that specify which replicas or regions should be used for non-transactional reads or queries.
SpannerOptions.Builder	setEmulatorHost(String emulatorHost)	Sets the host of an emulator to use.
SpannerOptions.Builder	setEnableApiTracing(boolean enableApiTracing)	Creates and sets an ApiTracer for the RPCs that are executed by this client.
SpannerOptions.Builder	setEnableDirectAccess(boolean enableDirectAccess)
SpannerOptions.Builder	setEnableEndToEndTracing(boolean enableEndToEndTracing)	Sets whether to enable end to end tracing.
SpannerOptions.Builder	setEnableExtendedTracing(boolean enableExtendedTracing)	Sets whether to enable extended OpenTelemetry tracing.
SpannerOptions.Builder	setExperimentalHost(String host)
SpannerOptions.Builder	setGcpChannelPoolOptions(GcpManagedChannelOptions.GcpChannelPoolOptions gcpChannelPoolOptions)	Sets the channel pool options for dynamic channel pooling.
SpannerOptions.Builder	setGrpcGcpOtelMetricsEnabled(boolean enableGrpcGcpOtelMetrics)	Sets whether to enable or disable grpc-gcp OpenTelemetry metrics injection.
SpannerOptions.Builder	setHost(String host)
SpannerOptions.Builder	setInterceptorProvider(GrpcInterceptorProvider interceptorProvider)	Sets the GrpcInterceptorProvider.
SpannerOptions.Builder	setMonitoringHost(String monitoringHost)	Deprecated.
SpannerOptions.Builder	setNumChannels(int numChannels)	Sets the number of gRPC channels to use.
SpannerOptions.Builder	setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)	Sets OpenTelemetry object to be used for Spanner Metrics and Traces.
SpannerOptions.Builder	setPartitionedDmlTimeout(org.threeten.bp.Duration timeout)	This method is obsolete.
SpannerOptions.Builder	setPartitionedDmlTimeoutDuration(Duration timeout)	Sets a timeout specifically for Partitioned DML statements executed through DatabaseClient.executePartitionedUpdate(Statement, UpdateOption...).
SpannerOptions.Builder	setPrefetchChunks(int prefetchChunks)	Specifying this will allow the client to prefetch up to prefetchChunks PartialResultSet chunks for each read and query.
SpannerOptions.Builder	setRetrySettings(RetrySettings retrySettings)	SpannerOptions.Builder does not support global retry settings, as it creates three different gRPC clients: Spanner, DatabaseAdminClient and InstanceAdminClient.
SpannerOptions.Builder	setSessionLabels(Map<String,String> sessionLabels)	Sets the labels to add to all Sessions created in this client.
SpannerOptions.Builder	setSessionPoolOption(SessionPoolOptions sessionPoolOptions)	Sets the options for managing the session pool.
SpannerOptions.Builder	setTrackTransactionStarter()	Instructs the client library to track the first request of each read/write transaction.
SpannerOptions.Builder	setTransportOptions(TransportOptions transportOptions)
protected SpannerOptions.Builder	setUseVirtualThreads(boolean useVirtualThreads)	Enables/disables the use of virtual threads for the gRPC executor.
SpannerOptions.Builder	useClientCert(String clientCertificate, String clientCertificateKey)	Configures mTLS authentication using the provided client certificate and key files. mTLS is only supported for experimental spanner hosts.
SpannerOptions.Builder	usePlainText()	usePlainText will configure the transport to use plaintext (no TLS) and will set credentials to NoCredentials to avoid sending authentication over an unsecured channel.

Methods inherited from class com.google.cloud.ServiceOptions.Builder

self, setApiTracerFactory, setClock, setCredentials, setHeaderProvider, setProjectId, setQuotaProjectId, setServiceFactory, setServiceRpcFactory, setUniverseDomain

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

protected Builder()

Method Details

setTransportOptions

public SpannerOptions.Builder setTransportOptions(TransportOptions transportOptions)

Overrides:

setTransportOptions in class ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

getAllowedClientLibTokens

protected Set<String> getAllowedClientLibTokens()

Overrides:

getAllowedClientLibTokens in class ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

setClientLibToken

@InternalApi
public SpannerOptions.Builder setClientLibToken(String clientLibToken)

Overrides:

setClientLibToken in class ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

setChannelProvider

public SpannerOptions.Builder setChannelProvider(TransportChannelProvider channelProvider)

Sets the ChannelProvider. GapicSpannerRpc would create a default one if none is provided.

Setting a custom TransportChannelProvider also overrides any other settings that affect the default channel provider. These must be set manually on the custom TransportChannelProvider instead of on SpannerOptions. The settings of SpannerOptions that have no effect if you set a custom TransportChannelProvider are:

1. setChannelConfigurator(ApiFunction)
2. setHost(String)
3. setNumChannels(int)
4. setInterceptorProvider(GrpcInterceptorProvider)
5. ServiceOptions.Builder.setHeaderProvider(com.google.api.gax.rpc.HeaderProvider)

setChannelEndpointCacheFactory

@InternalApi
public SpannerOptions.Builder setChannelEndpointCacheFactory(ChannelEndpointCacheFactory channelEndpointCacheFactory)

setChannelConfigurator

public SpannerOptions.Builder setChannelConfigurator(ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder> channelConfigurator)

Sets an ApiFunction that will be used to configure the transport channel. This will only be used if no custom TransportChannelProvider has been set.

setInterceptorProvider

public SpannerOptions.Builder setInterceptorProvider(GrpcInterceptorProvider interceptorProvider)

Sets the GrpcInterceptorProvider. GapicSpannerRpc would create a default one if none is provided.

setNumChannels

public SpannerOptions.Builder setNumChannels(int numChannels)

Sets the number of gRPC channels to use. By default 4 channels are created per SpannerOptions.

setSessionPoolOption

public SpannerOptions.Builder setSessionPoolOption(SessionPoolOptions sessionPoolOptions)

Sets the options for managing the session pool. If not specified then the default SessionPoolOptions is used.

setDatabaseRole

public SpannerOptions.Builder setDatabaseRole(String databaseRole)

Sets the database role that should be used for connections that are created by this instance. The database role that is used determines the access permissions that a connection has. This can for example be used to create connections that are only permitted to access certain tables.

setSessionLabels

public SpannerOptions.Builder setSessionLabels(Map<String,String> sessionLabels)

Sets the labels to add to all Sessions created in this client.

Parameters:

sessionLabels - Map from label key to label value. Label key and value cannot be null. For more information on valid syntax see api docs .

setRetrySettings

public SpannerOptions.Builder setRetrySettings(RetrySettings retrySettings)

SpannerOptions.Builder does not support global retry settings, as it creates three different gRPC clients: Spanner, DatabaseAdminClient and InstanceAdminClient. Instead of calling this method, you should set specific RetrySettings for each of the underlying gRPC clients by calling respectively getSpannerStubSettingsBuilder(), getDatabaseAdminStubSettingsBuilder() or getInstanceAdminStubSettingsBuilder().

Overrides:

setRetrySettings in class ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

getSpannerStubSettingsBuilder

public SpannerStubSettings.Builder getSpannerStubSettingsBuilder()

Returns the SpannerStubSettings.Builder that will be used to build the SpannerRpc. Use this to set custom RetrySettings for individual gRPC methods.

The library will automatically use the defaults defined in SpannerStubSettings if no custom settings are set. The defaults are the same as the defaults that are used by SpannerSettings, and are generated from the file spanner_gapic.yaml. Retries are configured for idempotent methods but not for non-idempotent methods.

You can set the same RetrySettings for all unary methods by calling this:

 builder
     .getSpannerStubSettingsBuilder()
     .applyToAllUnaryMethods(
         new ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>() {
           public Void apply(Builder<?, ?> input) {
             input.setRetrySettings(retrySettings);
             return null;
           }
         });
 

getInstanceAdminStubSettingsBuilder

public InstanceAdminStubSettings.Builder getInstanceAdminStubSettingsBuilder()

Returns the InstanceAdminStubSettings.Builder that will be used to build the SpannerRpc. Use this to set custom RetrySettings for individual gRPC methods.

The library will automatically use the defaults defined in InstanceAdminStubSettings if no custom settings are set. The defaults are the same as the defaults that are used by InstanceAdminSettings, and are generated from the file spanner_admin_instance_gapic.yaml. Retries are configured for idempotent methods but not for non-idempotent methods.

You can set the same RetrySettings for all unary methods by calling this:

 builder
     .getInstanceAdminStubSettingsBuilder()
     .applyToAllUnaryMethods(
         new ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>() {
           public Void apply(Builder<?, ?> input) {
             input.setRetrySettings(retrySettings);
             return null;
           }
         });
 

getDatabaseAdminStubSettingsBuilder

public DatabaseAdminStubSettings.Builder getDatabaseAdminStubSettingsBuilder()

Returns the DatabaseAdminStubSettings.Builder that will be used to build the SpannerRpc. Use this to set custom RetrySettings for individual gRPC methods.

The library will automatically use the defaults defined in DatabaseAdminStubSettings if no custom settings are set. The defaults are the same as the defaults that are used by DatabaseAdminSettings, and are generated from the file spanner_admin_database_gapic.yaml. Retries are configured for idempotent methods but not for non-idempotent methods.

You can set the same RetrySettings for all unary methods by calling this:

 builder
     .getDatabaseAdminStubSettingsBuilder()
     .applyToAllUnaryMethods(
         new ApiFunction<UnaryCallSettings.Builder<?, ?>, Void>() {
           public Void apply(Builder<?, ?> input) {
             input.setRetrySettings(retrySettings);
             return null;
           }
         });
 

setPartitionedDmlTimeout

@ObsoleteApi("Use setPartitionedDmlTimeoutDuration(Duration) instead")
public SpannerOptions.Builder setPartitionedDmlTimeout(org.threeten.bp.Duration timeout)

This method is obsolete. Use setPartitionedDmlTimeoutDuration(Duration) instead.

setPartitionedDmlTimeoutDuration

public SpannerOptions.Builder setPartitionedDmlTimeoutDuration(Duration timeout)

Sets a timeout specifically for Partitioned DML statements executed through DatabaseClient.executePartitionedUpdate(Statement, UpdateOption...). The default is 2 hours.

setAutoThrottleAdministrativeRequests

public SpannerOptions.Builder setAutoThrottleAdministrativeRequests()

Instructs the client library to automatically throttle the number of administrative requests if the rate of administrative requests generated by this Spanner instance will exceed the administrative limits Cloud Spanner. The default behavior is to not throttle any requests. If the limit is exceeded, Cloud Spanner will return a RESOURCE_EXHAUSTED error. More information on the administrative limits can be found here: https://cloud.google.com/spanner/quotas#administrative_limits. Setting this option is not a guarantee that the rate will never be exceeded, as this option will only throttle requests coming from this client. Additional requests from other clients could still cause the limit to be exceeded.

disableAdministrativeRequestRetries

public SpannerOptions.Builder disableAdministrativeRequestRetries()

Disables automatic retries of administrative requests that fail if the https://cloud.google.com/spanner/quotas#administrative_limits have been exceeded. You should disable these retries if you intend to handle these errors in your application.

setTrackTransactionStarter

public SpannerOptions.Builder setTrackTransactionStarter()

Instructs the client library to track the first request of each read/write transaction. This statement will include a BeginTransaction option and will return a transaction id as part of its result. All other statements in the same transaction must wait for this first statement to finish before they can proceed. By setting this option the client library will throw a SpannerException with ErrorCode.DEADLINE_EXCEEDED for any subsequent statement that has waited for at least 60 seconds for the first statement to return a transaction id, including the stacktrace of the initial statement that should have returned a transaction id.

setDefaultQueryOptions

public SpannerOptions.Builder setDefaultQueryOptions(DatabaseId database,
 ExecuteSqlRequest.QueryOptions defaultQueryOptions)

Sets the default ExecuteSqlRequest.QueryOptions that will be used for all queries on the specified database. Query options can also be specified on a per-query basis and as environment variables. The precedence of these settings are:

1. Query options for a specific query
2. Environment variables
3. These default query options

Each Options.QueryOption value that is used for a query is determined individually based on the above precedence. If for example a value for ExecuteSqlRequest.QueryOptions.getOptimizerVersion() is specified in an environment variable and a value for ExecuteSqlRequest.QueryOptions.getOptimizerStatisticsPackage() is specified for a specific query, both values will be used for the specific query. Environment variables are only read during the initialization of a SpannerOptions instance. Changing an environment variable after initializing a SpannerOptions instance will not have any effect on that instance.

setCallCredentialsProvider

public SpannerOptions.Builder setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider callCredentialsProvider)

Sets a SpannerOptions.CallCredentialsProvider that can deliver CallCredentials to use on a per-gRPC basis.

setCompressorName

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1704")
public SpannerOptions.Builder setCompressorName(@Nullable
 String compressorName)

Sets the compression to use for all gRPC calls. The compressor must be a valid name known in the CompressorRegistry. This will enable compression both from the client to the server and from the server to the client.

Supported values are:

• gzip: Enable gzip compression
• identity: Disable compression
• null: Use default compression

setAsyncExecutorProvider

public SpannerOptions.Builder setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider provider)

Sets the ExecutorProvider to use for high-level async calls that need an executor, such as fetching results for an AsyncResultSet.

Async methods will use a sensible default if no custom ExecutorProvider has been set. The default ExecutorProvider uses a cached thread pool containing a maximum of 8 threads. The pool is lazily initialized and will not create any threads if the user application does not use any async methods. It will also scale down the thread usage if the async load allows for that.

Call SpannerOptions.createAsyncExecutorProvider(int, long, TimeUnit) to create a provider with a custom pool size or call SpannerOptions.FixedCloseableExecutorProvider.create(ScheduledExecutorService) to create a SpannerOptions.CloseableExecutorProvider from a standard Java ScheduledExecutorService.

setDirectedReadOptions

public SpannerOptions.Builder setDirectedReadOptions(DirectedReadOptions directedReadOptions)

Sets the Options.DirectedReadOption that specify which replicas or regions should be used for non-transactional reads or queries.

DirectedReadOptions set at the request level will take precedence over the options set using this method.

An example below of how DirectedReadOptions can be constructed by including a replica.

 DirectedReadOptions.newBuilder()
           .setIncludeReplicas(
               IncludeReplicas.newBuilder()
                   .addReplicaSelections(
                       ReplicaSelection.newBuilder().setLocation("us-east1").build()))
           .build();
           }
 

setPrefetchChunks

public SpannerOptions.Builder setPrefetchChunks(int prefetchChunks)

Specifying this will allow the client to prefetch up to prefetchChunks PartialResultSet chunks for each read and query. The data size of each chunk depends on the server implementation but a good rule of thumb is that each chunk will be up to 1 MiB. Larger values reduce the likelihood of blocking while consuming results at the cost of greater memory consumption. prefetchChunks should be greater than 0. To get good performance choose a value that is large enough to allow buffering of chunks for an entire row. Apart from the buffered chunks, there can be at most one more row buffered in the client. This can be overridden on a per read/query basis by Options.prefetchChunks(). If unspecified, we will use a default value (currently 4).

setDecodeMode

public SpannerOptions.Builder setDecodeMode(DecodeMode decodeMode)

Specifies how values that are returned from a query should be decoded and converted from protobuf values into plain Java objects.

setHost

public SpannerOptions.Builder setHost(String host)

Overrides:

setHost in class ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>

setExperimentalHost

@ExperimentalApi("https://github.com/googleapis/java-spanner/pull/3676")
public SpannerOptions.Builder setExperimentalHost(String host)

enableGrpcGcpExtension

public SpannerOptions.Builder enableGrpcGcpExtension()

Enables gRPC-GCP extension with the default settings. This option is enabled by default.

enableGrpcGcpExtension

public SpannerOptions.Builder enableGrpcGcpExtension(GcpManagedChannelOptions options)

Enables gRPC-GCP extension and uses provided options for configuration. The metric registry and default Spanner metric labels will be added automatically.

disableGrpcGcpExtension

public SpannerOptions.Builder disableGrpcGcpExtension()

Disables gRPC-GCP extension and uses GAX channel pool instead.

enableDynamicChannelPool

public SpannerOptions.Builder enableDynamicChannelPool()

Enables dynamic channel pooling. When enabled, the client will automatically scale the number of channels based on load. This requires the gRPC-GCP extension to be enabled.

Dynamic channel pooling is disabled by default. Use this method to explicitly enable it. Note that calling setNumChannels(int) will disable dynamic channel pooling even if this method was called.

disableDynamicChannelPool

public SpannerOptions.Builder disableDynamicChannelPool()

Disables dynamic channel pooling. When disabled, the client will use a static number of channels as configured by setNumChannels(int).

Dynamic channel pooling is disabled by default, so this method is typically not needed unless you want to explicitly disable it after enabling it.

setGrpcGcpOtelMetricsEnabled

public SpannerOptions.Builder setGrpcGcpOtelMetricsEnabled(boolean enableGrpcGcpOtelMetrics)

Sets whether to enable or disable grpc-gcp OpenTelemetry metrics injection. When disabled, Spanner will not automatically inject an OpenTelemetry Meter into grpc-gcp. If a Meter or MetricRegistry is explicitly provided via GcpManagedChannelOptions, those settings will still be honored.

setGcpChannelPoolOptions

public SpannerOptions.Builder setGcpChannelPoolOptions(GcpManagedChannelOptions.GcpChannelPoolOptions gcpChannelPoolOptions)

Sets the channel pool options for dynamic channel pooling. Use this to configure the dynamic channel pool behavior when enableDynamicChannelPool() is enabled.

If not set, Spanner-specific defaults will be used (see SpannerOptions.createDefaultDynamicChannelPoolOptions()).

Example usage:

 SpannerOptions options = SpannerOptions.newBuilder()
     .setProjectId("my-project")
     .enableDynamicChannelPool()
     .setGcpChannelPoolOptions(
         GcpChannelPoolOptions.newBuilder()
             .setMaxSize(15)
             .setMinSize(3)
             .setInitSize(5)
             .setDynamicScaling(10, 30, Duration.ofMinutes(5))
             .build())
     .build();
 

Parameters:

gcpChannelPoolOptions - the channel pool options to use

Returns:

this builder for chaining

setEmulatorHost

public SpannerOptions.Builder setEmulatorHost(String emulatorHost)

Sets the host of an emulator to use. By default the value is read from an environment variable. If the environment variable is not set, this will be null.

useClientCert

@ExperimentalApi("https://github.com/googleapis/java-spanner/pull/3574")
public SpannerOptions.Builder useClientCert(String clientCertificate,
 String clientCertificateKey)

Configures mTLS authentication using the provided client certificate and key files. mTLS is only supported for experimental spanner hosts.

Parameters:

clientCertificate - Path to the client certificate file.

clientCertificateKey - Path to the client private key file.

Throws:

SpannerException - If an error occurs while configuring the mTLS context

usePlainText

@ExperimentalApi("https://github.com/googleapis/java-spanner/pull/4264")
public SpannerOptions.Builder usePlainText()

usePlainText will configure the transport to use plaintext (no TLS) and will set credentials to NoCredentials to avoid sending authentication over an unsecured channel.

setOpenTelemetry

public SpannerOptions.Builder setOpenTelemetry(io.opentelemetry.api.OpenTelemetry openTelemetry)

Sets OpenTelemetry object to be used for Spanner Metrics and Traces. GlobalOpenTelemetry will be used as fallback if this options is not set.

enableLeaderAwareRouting

public SpannerOptions.Builder enableLeaderAwareRouting()

Enable leader aware routing. Leader aware routing would route all requests in RW/PDML transactions to the leader region.

disableLeaderAwareRouting

public SpannerOptions.Builder disableLeaderAwareRouting()

Disable leader aware routing. Disabling leader aware routing would route all requests in RW/PDML transactions to any region.

setEnableDirectAccess

@BetaApi
public SpannerOptions.Builder setEnableDirectAccess(boolean enableDirectAccess)

disableDirectPath

@ObsoleteApi("Use setEnableDirectAccess(false) instead")
@Deprecated
public SpannerOptions.Builder disableDirectPath()

Deprecated.

setUseVirtualThreads

@BetaApi
protected SpannerOptions.Builder setUseVirtualThreads(boolean useVirtualThreads)

Enables/disables the use of virtual threads for the gRPC executor. Setting this option only has any effect on Java 21 and higher. In all other cases, the option will be ignored.

setEnableApiTracing

public SpannerOptions.Builder setEnableApiTracing(boolean enableApiTracing)

Creates and sets an ApiTracer for the RPCs that are executed by this client. Enabling this creates traces for each individual RPC execution, including events/annotations when an RPC is retried or fails. The traces are only exported if an OpenTelemetry or OpenCensus trace exporter has been configured for the client.

setBuiltInMetricsEnabled

public SpannerOptions.Builder setBuiltInMetricsEnabled(boolean enableBuiltInMetrics)

Sets whether to enable or disable built in metrics for Data client operations. Built in metrics are enabled by default.

setMonitoringHost

@Deprecated
@ObsoleteApi("This will be removed in an upcoming version without a major version bump. You should use universalDomain to configure the built-in metrics endpoint for a partner universe.")
public SpannerOptions.Builder setMonitoringHost(String monitoringHost)

Deprecated.

Sets the monitoring host to be used for Built-in client side metrics

setEnableExtendedTracing

public SpannerOptions.Builder setEnableExtendedTracing(boolean enableExtendedTracing)

Sets whether to enable extended OpenTelemetry tracing. Enabling this option will add the following additional attributes to the traces that are generated by the client:

• db.statement: Contains the SQL statement that is being executed.
• thread.name: The name of the thread that executes the statement.

setEnableEndToEndTracing

public SpannerOptions.Builder setEnableEndToEndTracing(boolean enableEndToEndTracing)

Sets whether to enable end to end tracing. Enabling this option will create the trace spans at the Spanner layer. By default, end to end tracing is disabled. Enabling end to end tracing requires OpenTelemetry to be set up. Simply enabling this option won't generate traces at Spanner layer.

setDefaultTransactionOptions

public SpannerOptions.Builder setDefaultTransactionOptions(SpannerOptions.Builder.DefaultReadWriteTransactionOptions defaultReadWriteTransactionOptions)

Sets the SpannerOptions.Builder.DefaultReadWriteTransactionOptions for read-write transactions.

setDefaultClientContext

public SpannerOptions.Builder setDefaultClientContext(RequestOptions.ClientContext clientContext)

Sets the default RequestOptions.ClientContext for all requests.

build

public SpannerOptions build()

Specified by:

build in class ServiceOptions.Builder<Spanner,SpannerOptions,SpannerOptions.Builder>