# Class SpannerOptions.Builder (6.118.0)

6.118.0 (latest) 6.116.0 6.111.1 6.108.0 6.107.0 6.103.0 6.102.1 6.101.1 6.100.0 6.99.0 6.98.1 6.97.1 6.96.1 6.95.1 6.94.0 6.93.0 6.89.0 6.88.0 6.87.0 6.86.0 6.85.0 6.83.0 6.82.0 6.80.1 6.79.0 6.77.0 6.74.1 6.72.0 6.71.0 6.69.0 6.68.0 6.66.0 6.65.1 6.62.0 6.60.0 6.58.0 6.57.0 6.56.0 6.55.0 6.54.0 6.53.0 6.52.1 6.51.0 6.50.1 6.49.0 6.25.1 6.24.0 6.23.4 6.22.0 6.21.2 6.20.0 6.19.1 6.18.0 6.17.4 6.14.1

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

Builder for [SpannerOptions](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions) instances.

## Inheritance

[java.lang.Object](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html) \> com.google.cloud.ServiceOptions.Builder \> SpannerOptions.Builder

## Inherited Members

com.google.cloud.ServiceOptions.Builder.build() com.google.cloud.ServiceOptions.Builder.getAllowedClientLibTokens() com.google.cloud.ServiceOptions.Builder.self() com.google.cloud.ServiceOptions.Builder.setApiTracerFactory(com.google.api.gax.tracing.ApiTracerFactory) com.google.cloud.ServiceOptions.Builder.setClientLibToken(java.lang.String) com.google.cloud.ServiceOptions.Builder.setClock(com.google.api.core.ApiClock) com.google.cloud.ServiceOptions.Builder.setCredentials(com.google.auth.Credentials) com.google.cloud.ServiceOptions.Builder.setHeaderProvider(com.google.api.gax.rpc.HeaderProvider) com.google.cloud.ServiceOptions.Builder.setHost(java.lang.String) com.google.cloud.ServiceOptions.Builder.setProjectId(java.lang.String) com.google.cloud.ServiceOptions.Builder.setQuotaProjectId(java.lang.String) com.google.cloud.ServiceOptions.Builder.setRetrySettings(com.google.api.gax.retrying.RetrySettings) com.google.cloud.ServiceOptions.Builder.setServiceFactory(com.google.cloud.ServiceFactory\<ServiceT,OptionsT\>) com.google.cloud.ServiceOptions.Builder.setServiceRpcFactory(com.google.cloud.spi.ServiceRpcFactory\<OptionsT\>) com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions) com.google.cloud.ServiceOptions.Builder.setUniverseDomain(java.lang.String) [Object.clone()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--) [Object.equals(Object)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-) [Object.finalize()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--) [Object.getClass()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--) [Object.hashCode()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--) [Object.notify()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--) [Object.notifyAll()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--) [Object.toString()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--) [Object.wait()](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--) [Object.wait(long)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-) [Object.wait(long,int)](https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-)

## Constructors

### Builder()

    protected Builder()

## Methods

### build()

    public SpannerOptions build()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions` |   |

**Overrides** com.google.cloud.ServiceOptions.Builder.build()

### 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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### disableAutoTagging()

    public SpannerOptions.Builder disableAutoTagging()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### disableDirectPath() (deprecated)

    public SpannerOptions.Builder disableDirectPath()

> [!WARNING]
> **Obsolete**
>
> *Use setEnableDirectAccess(false) instead*
>
> This feature is stable for usage in this major version, but may be deprecated in a future release.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### 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)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### disableGrpcGcpExtension()

    public SpannerOptions.Builder disableGrpcGcpExtension()

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### disableLeaderAwareRouting()

    public SpannerOptions.Builder disableLeaderAwareRouting()

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### enableAutoTagging()

    public SpannerOptions.Builder enableAutoTagging()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### 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)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_setNumChannels_int_) will disable dynamic channel pooling even if
this method was called.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### enableGrpcGcpExtension()

    public SpannerOptions.Builder enableGrpcGcpExtension()

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### enableGrpcGcpExtension(GcpManagedChannelOptions options)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `options` | `com.google.cloud.grpc.GcpManagedChannelOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### enableLeaderAwareRouting()

    public SpannerOptions.Builder enableLeaderAwareRouting()

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### getAllowedClientLibTokens()

    protected Set<String> getAllowedClientLibTokens()

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/Set.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |   |

**Overrides** com.google.cloud.ServiceOptions.Builder.getAllowedClientLibTokens()

### getDatabaseAdminStubSettingsBuilder()

    public DatabaseAdminStubSettings.Builder getDatabaseAdminStubSettingsBuilder()

Returns the [DatabaseAdminStubSettings.Builder](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings.Builder) that will be used to build the [SpannerRpc](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.spi.v1.SpannerRpc). Use this to set custom [RetrySettings](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html) for individual gRPC methods.

The library will automatically use the defaults defined in [DatabaseAdminStubSettings](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings) if no custom settings are set. The defaults are the same as the
defaults that are used by [DatabaseAdminSettings](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.database.v1.DatabaseAdminSettings), and are generated from the file [spanner_admin_database_gapic.yaml](https://github.com/googleapis/googleapis/blob/master/google/spanner/admin/database/v1/spanner_admin_database_gapic.yaml).
Retries are configured for idempotent methods but not for non-idempotent methods.

You can set the same [RetrySettings](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html) 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;
               }
             });
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings.Builder` |   |

### getInstanceAdminStubSettingsBuilder()

    public InstanceAdminStubSettings.Builder getInstanceAdminStubSettingsBuilder()

Returns the [InstanceAdminStubSettings.Builder](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings.Builder) that will be used to build the [SpannerRpc](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.spi.v1.SpannerRpc). Use this to set custom [RetrySettings](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html) for individual gRPC methods.

The library will automatically use the defaults defined in [InstanceAdminStubSettings](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings) if no custom settings are set. The defaults are the same as the
defaults that are used by [InstanceAdminSettings](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.instance.v1.InstanceAdminSettings), and are generated from the file [spanner_admin_instance_gapic.yaml](https://github.com/googleapis/googleapis/blob/master/google/spanner/admin/instance/v1/spanner_admin_instance_gapic.yaml).
Retries are configured for idempotent methods but not for non-idempotent methods.

You can set the same [RetrySettings](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html) 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;
               }
             });
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings.Builder` |   |

### getSpannerStubSettingsBuilder()

    public SpannerStubSettings.Builder getSpannerStubSettingsBuilder()

Returns the [SpannerStubSettings.Builder](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.v1.stub.SpannerStubSettings.Builder) that will be used to build the [SpannerRpc](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.spi.v1.SpannerRpc). Use this to set custom [RetrySettings](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html) for individual gRPC methods.

The library will automatically use the defaults defined in [SpannerStubSettings](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.v1.stub.SpannerStubSettings) if
no custom settings are set. The defaults are the same as the defaults that are used by [SpannerSettings](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.v1.SpannerSettings), and are generated from the file [spanner_gapic.yaml](https://github.com/googleapis/googleapis/blob/master/google/spanner/v1/spanner_gapic.yaml).
Retries are configured for idempotent methods but not for non-idempotent methods.

You can set the same [RetrySettings](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html) 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;
               }
             });
     
| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.v1.stub.SpannerStubSettings.Builder` |   |

### setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider provider)

    public SpannerOptions.Builder setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider provider)

Sets the [ExecutorProvider](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.core.ExecutorProvider.html) to use for high-level async calls that need an executor,
such as fetching results for an [AsyncResultSet](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.AsyncResultSet).

Async methods will use a sensible default if no custom [ExecutorProvider](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.core.ExecutorProvider.html) has been
set. The default [ExecutorProvider](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.core.ExecutorProvider.html) 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)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions#com_google_cloud_spanner_SpannerOptions_createAsyncExecutorProvider_int_long_java_util_concurrent_TimeUnit_) to create a
provider with a custom pool size or call FixedCloseableExecutorProvider#create(ScheduledExecutorService) to create a CloseableExecutorProvider from a standard Java ScheduledExecutorService.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `provider` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.CloseableExecutorProvider` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setAutoTaggingPackages(String\[\] autoTaggingPackages)

    public SpannerOptions.Builder setAutoTaggingPackages(String[] autoTaggingPackages)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `autoTaggingPackages` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html[]` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setAutoTaggingPackages(List\<String\> autoTaggingPackages)

    public SpannerOptions.Builder setAutoTaggingPackages(List<String> autoTaggingPackages)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `autoTaggingPackages` | `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setAutoTaggingTracerLimit(int autoTaggingTracerLimit)

    public SpannerOptions.Builder setAutoTaggingTracerLimit(int autoTaggingTracerLimit)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `autoTaggingTracerLimit` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### 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](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setBuiltInMetricsEnabled(boolean enableBuiltInMetrics)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `enableBuiltInMetrics` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider callCredentialsProvider)

    public SpannerOptions.Builder setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider callCredentialsProvider)

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `callCredentialsProvider` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.CallCredentialsProvider` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setChannelConfigurator(ApiFunction\<ManagedChannelBuilder,ManagedChannelBuilder\> channelConfigurator)

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

Sets an [ApiFunction](https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFunction.html) that will be used to configure the transport channel. This will
only be used if no custom [TransportChannelProvider](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.TransportChannelProvider.html) has been set.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `channelConfigurator` | `https://docs.cloud.google.com/java/docs/reference/api-common/latest/com.google.api.core.ApiFunction.html<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder>` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setChannelEndpointCacheFactory(ChannelEndpointCacheFactory channelEndpointCacheFactory)

    public SpannerOptions.Builder setChannelEndpointCacheFactory(ChannelEndpointCacheFactory channelEndpointCacheFactory)

> [!WARNING]
> **Internal Only**: This feature is not stable for application use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `channelEndpointCacheFactory` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.spi.v1.ChannelEndpointCacheFactory` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setChannelProvider(TransportChannelProvider channelProvider)

    public SpannerOptions.Builder setChannelProvider(TransportChannelProvider channelProvider)

Sets the `ChannelProvider`. [GapicSpannerRpc](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.spi.v1.GapicSpannerRpc) would create a default one if none
is provided.

Setting a custom [TransportChannelProvider](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.TransportChannelProvider.html) also overrides any other settings that
affect the default channel provider. These must be set manually on the custom [TransportChannelProvider](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.TransportChannelProvider.html) instead of on [SpannerOptions](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions). The settings of [SpannerOptions](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions) that have no effect if you set a custom [TransportChannelProvider](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.TransportChannelProvider.html) are:

1. [#setChannelConfigurator(ApiFunction)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_setChannelConfigurator_com_google_api_core_ApiFunction_io_grpc_ManagedChannelBuilder_io_grpc_ManagedChannelBuilder__)
2. [#setHost(String)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_setHost_java_lang_String_)
3. [#setNumChannels(int)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_setNumChannels_int_)
4. [#setInterceptorProvider(GrpcInterceptorProvider)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_setInterceptorProvider_com_google_api_gax_grpc_GrpcInterceptorProvider_)
5. #setHeaderProvider(com.google.api.gax.rpc.HeaderProvider)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `channelProvider` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.rpc.TransportChannelProvider.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setClientLibToken(String clientLibToken)

    public SpannerOptions.Builder setClientLibToken(String clientLibToken)

> [!WARNING]
> **Internal Only**: This feature is not stable for application use.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `clientLibToken` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

**Overrides** com.google.cloud.ServiceOptions.Builder.setClientLibToken(java.lang.String)

### setCompressorName(String compressorName)

    public SpannerOptions.Builder setCompressorName(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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `compressorName` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setDatabaseRole(String databaseRole)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `databaseRole` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setDecodeMode(DecodeMode decodeMode)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `decodeMode` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.DecodeMode` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setDefaultClientContext(RequestOptions.ClientContext clientContext)

    public SpannerOptions.Builder setDefaultClientContext(RequestOptions.ClientContext clientContext)

Sets the default [RequestOptions.ClientContext](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.v1.RequestOptions.ClientContext) for all requests.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `clientContext` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.v1.RequestOptions.ClientContext` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setDefaultQueryOptions(DatabaseId database, ExecuteSqlRequest.QueryOptions defaultQueryOptions)

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

Sets the default 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 QueryOption value that is used for a query is determined individually based on
the above precedence. If for example a value for QueryOptions#getOptimizerVersion()
is specified in an environment variable and a value for 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](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions) instance. Changing an environment variable after
initializing a [SpannerOptions](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions) instance will not have any effect on that instance.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `database` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.DatabaseId` |
| `defaultQueryOptions` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.v1.ExecuteSqlRequest.QueryOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

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

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

Sets the DefaultReadWriteTransactionOptions for read-write transactions.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `defaultReadWriteTransactionOptions` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder.DefaultReadWriteTransactionOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setDirectedReadOptions(DirectedReadOptions directedReadOptions)

    public SpannerOptions.Builder setDirectedReadOptions(DirectedReadOptions directedReadOptions)

Sets the 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](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.v1.DirectedReadOptions) can be constructed by including a
replica.


     DirectedReadOptions.newBuilder()
               .setIncludeReplicas(
                   IncludeReplicas.newBuilder()
                       .addReplicaSelections(
                           ReplicaSelection.newBuilder().setLocation("us-east1").build()))
               .build();
               }
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `directedReadOptions` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.spanner.v1.DirectedReadOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setEmulatorHost(String emulatorHost)

    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`.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `emulatorHost` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setEnableApiTracing(boolean enableApiTracing)

    public SpannerOptions.Builder setEnableApiTracing(boolean enableApiTracing)

Creates and sets an [com.google.api.gax.tracing.ApiTracer](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.tracing.ApiTracer.html) 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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `enableApiTracing` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setEnableDirectAccess(boolean enableDirectAccess)

    public SpannerOptions.Builder setEnableDirectAccess(boolean enableDirectAccess)

> [!WARNING]
> **Beta**
>
> This feature is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1) of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `enableDirectAccess` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setEnableEndToEndTracing(boolean enableEndToEndTracing)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `enableEndToEndTracing` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setEnableExtendedTracing(boolean enableExtendedTracing)

    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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `enableExtendedTracing` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setExperimentalHost(String host) (deprecated)

    public SpannerOptions.Builder setExperimentalHost(String host)

> [!WARNING]
> **Obsolete**
>
> *Use setHost(String).setType(InstanceType.OMNI) instead*
>
> This feature is stable for usage in this major version, but may be deprecated in a future release.

**Deprecated.** *Use #setType(InstanceType) instead.*

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `host` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setGcpChannelPoolOptions(GcpManagedChannelOptions.GcpChannelPoolOptions gcpChannelPoolOptions)

    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()](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_enableDynamicChannelPool__) is enabled.

If not set, Spanner-specific defaults will be used (see #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();
     
| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `gcpChannelPoolOptions` | `com.google.cloud.grpc.GcpManagedChannelOptions.GcpChannelPoolOptions` the channel pool options to use |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` | this builder for chaining |

### setGrpcGcpOtelMetricsEnabled(boolean enableGrpcGcpOtelMetrics)

    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 io.opentelemetry.api.metrics.Meter into grpc-gcp. If a Meter or MetricRegistry is explicitly
provided via GcpManagedChannelOptions, those settings will still be honored.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `enableGrpcGcpOtelMetrics` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setHost(String host)

    public SpannerOptions.Builder setHost(String host)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `host` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

**Overrides** com.google.cloud.ServiceOptions.Builder.setHost(java.lang.String)

### setInterceptorProvider(GrpcInterceptorProvider interceptorProvider)

    public SpannerOptions.Builder setInterceptorProvider(GrpcInterceptorProvider interceptorProvider)

Sets the `GrpcInterceptorProvider`. [GapicSpannerRpc](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.spi.v1.GapicSpannerRpc) would create a default one
if none is provided.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `interceptorProvider` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.grpc.GrpcInterceptorProvider.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setMonitoringHost(String monitoringHost) (deprecated)

    public SpannerOptions.Builder setMonitoringHost(String monitoringHost)

> [!WARNING]
> **Obsolete**
>
> *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.*
>
> This feature is stable for usage in this major version, but may be deprecated in a future release.

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `monitoringHost` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setNumChannels(int numChannels)

    public SpannerOptions.Builder setNumChannels(int numChannels)

Sets the number of gRPC channels to use. By default 4 channels are created per [SpannerOptions](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `numChannels` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setOpenTelemetry(OpenTelemetry openTelemetry)

    public SpannerOptions.Builder setOpenTelemetry(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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `openTelemetry` | `io.opentelemetry.api.OpenTelemetry` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setPartitionedDmlTimeout(Duration timeout)

    public SpannerOptions.Builder setPartitionedDmlTimeout(Duration timeout)

> [!WARNING]
> **Obsolete**
>
> *Use setPartitionedDmlTimeoutDuration(Duration) instead*
>
> This feature is stable for usage in this major version, but may be deprecated in a future release.

This method is obsolete. Use [#setPartitionedDmlTimeoutDuration(Duration)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_setPartitionedDmlTimeoutDuration_java_time_Duration_) instead.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `timeout` | `org.threeten.bp.Duration` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setPartitionedDmlTimeoutDuration(Duration timeout)

    public SpannerOptions.Builder setPartitionedDmlTimeoutDuration(Duration timeout)

Sets a timeout specifically for Partitioned DML statements executed through [DatabaseClient#executePartitionedUpdate(Statement, UpdateOption...)](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.DatabaseClient#com_google_cloud_spanner_DatabaseClient_executePartitionedUpdate_). The default is 2 hours.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `timeout` | `https://docs.oracle.com/javase/8/docs/api/java/time/Duration.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setPrefetchChunks(int prefetchChunks)

    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()](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.Options#com_google_cloud_spanner_Options_prefetchChunks_). If unspecified,
we will use a default value (currently 4).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `prefetchChunks` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setRetrySettings(RetrySettings retrySettings)

    public SpannerOptions.Builder setRetrySettings(RetrySettings retrySettings)

[SpannerOptions.Builder](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder) does not support global retry settings, as it creates three
different gRPC clients: [Spanner](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.Spanner), [DatabaseAdminClient](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.database.v1.DatabaseAdminClient) and [InstanceAdminClient](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.admin.instance.v1.InstanceAdminClient). Instead of calling this method, you should set specific [RetrySettings](https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html) for each of the underlying gRPC clients by calling respectively [#getSpannerStubSettingsBuilder()](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_getSpannerStubSettingsBuilder__), [#getDatabaseAdminStubSettingsBuilder()](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_getDatabaseAdminStubSettingsBuilder__) or [#getInstanceAdminStubSettingsBuilder()](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder#com_google_cloud_spanner_SpannerOptions_Builder_getInstanceAdminStubSettingsBuilder__).

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `retrySettings` | `https://docs.cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

**Overrides** com.google.cloud.ServiceOptions.Builder.setRetrySettings(com.google.api.gax.retrying.RetrySettings)

### setSessionLabels(Map\<String,String\> sessionLabels)

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

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `sessionLabels` | `https://docs.oracle.com/javase/8/docs/api/java/util/Map.html<https://docs.oracle.com/javase/8/docs/api/java/lang/String.html,https://docs.oracle.com/javase/8/docs/api/java/lang/String.html>` Map from label key to label value. Label key and value cannot be null. For more information on valid syntax see [api docs](https://cloud.google.com/spanner/docs/reference/rpc/google.spanner.v1#google.spanner.v1.Session). |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setSessionPoolOption(SessionPoolOptions sessionPoolOptions)

    public SpannerOptions.Builder setSessionPoolOption(SessionPoolOptions sessionPoolOptions)

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

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `sessionPoolOptions` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SessionPoolOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### 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](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerException) with [ErrorCode#DEADLINE_EXCEEDED](https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.ErrorCode#com_google_cloud_spanner_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.

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setTransportOptions(TransportOptions transportOptions)

    public SpannerOptions.Builder setTransportOptions(TransportOptions transportOptions)

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `transportOptions` | `com.google.cloud.TransportOptions` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

**Overrides** com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)

### setType(SpannerOptions.InstanceType instanceType)

    public SpannerOptions.Builder setType(SpannerOptions.InstanceType instanceType)

Specifies the type of Spanner instance to connect to (CLOUD or OMNI). Setting it to OMNI is
mandatory when connecting to a Spanner Omni instance.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `instanceType` | `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.InstanceType` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### setUseVirtualThreads(boolean useVirtualThreads)

    protected SpannerOptions.Builder setUseVirtualThreads(boolean useVirtualThreads)

> [!WARNING]
> **Beta**
>
> This feature is covered by the [Pre-GA Offerings Terms](https://docs.cloud.google.com/terms/service-terms#1) of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

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.

| **Parameter** ||
|---|---|
| **Name** | **Description** |
| `useVirtualThreads` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### useClientCert(String clientCertificate, String clientCertificateKey)

    public SpannerOptions.Builder useClientCert(String clientCertificate, String clientCertificateKey)

Configures mTLS authentication using the provided client certificate and key files. mTLS via
useClientCert is only supported for Spanner Omni instances.

| **Parameters** ||
|---|---|
| **Name** | **Description** |
| `clientCertificate` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Path to the client certificate file. |
| `clientCertificateKey` | `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` Path to the client private key file. |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |

### usePlainText()

    public SpannerOptions.Builder usePlainText()

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-spanner/latest/com.google.cloud.spanner.SpannerOptions.Builder` |   |