Class SpannerOptions.Builder (2.41.0)

2.41.0 (latest) 2.40.0 2.38.0 2.35.4 2.34.0 2.33.2 2.32.3 2.31.2 2.30.4 2.28.0 2.27.1 2.26.1 2.25.1 2.24.1 2.23.0 2.22.1 2.21.0 2.20.2 2.19.3 2.18.1 2.17.0 2.16.1 2.15.5 2.14.6 2.13.4 2.11.4 2.10.0 2.9.16 2.8.0 2.7.12 2.6.4 2.5.11

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

Inheritance

java.lang.Object > 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)

com.google.cloud.ServiceOptions.Builder.setUseJwtAccessWithScope(boolean)

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

Builder()

protected Builder()

Methods

build()

public SpannerOptions build()

Returns
Type	Description
SpannerOptions

Overrides

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

disableAdministrativeRequestRetries()

public SpannerOptions.Builder disableAdministrativeRequestRetries()

Returns
Type	Description
SpannerOptions.Builder

disableAutoTagging()

public SpannerOptions.Builder disableAutoTagging()

Returns
Type	Description
SpannerOptions.Builder

disableDirectPath() (deprecated)

public SpannerOptions.Builder disableDirectPath()

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
SpannerOptions.Builder

disableDynamicChannelPool()

public SpannerOptions.Builder disableDynamicChannelPool()

Returns
Type	Description
SpannerOptions.Builder

disableGrpcGcpExtension()

public SpannerOptions.Builder disableGrpcGcpExtension()

Returns
Type	Description
SpannerOptions.Builder

disableLeaderAwareRouting()

public SpannerOptions.Builder disableLeaderAwareRouting()

Returns
Type	Description
SpannerOptions.Builder

enableAutoTagging()

public SpannerOptions.Builder enableAutoTagging()

Returns
Type	Description
SpannerOptions.Builder

enableDynamicChannelPool()

public SpannerOptions.Builder enableDynamicChannelPool()

Returns
Type	Description
SpannerOptions.Builder

enableGrpcGcpExtension()

public SpannerOptions.Builder enableGrpcGcpExtension()

Returns
Type	Description
SpannerOptions.Builder

enableGrpcGcpExtension(GcpManagedChannelOptions arg0)

public SpannerOptions.Builder enableGrpcGcpExtension(GcpManagedChannelOptions arg0)

Parameter
Name	Description
arg0	com.google.cloud.grpc.GcpManagedChannelOptions

Returns
Type	Description
SpannerOptions.Builder

enableLeaderAwareRouting()

public SpannerOptions.Builder enableLeaderAwareRouting()

Returns
Type	Description
SpannerOptions.Builder

getAllowedClientLibTokens()

protected Set<String> getAllowedClientLibTokens()

Returns
Type	Description
Set<String>

Overrides

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

getDatabaseAdminStubSettingsBuilder()

public DatabaseAdminStubSettings.Builder getDatabaseAdminStubSettingsBuilder()

Returns
Type	Description
com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings.Builder

getInstanceAdminStubSettingsBuilder()

public InstanceAdminStubSettings.Builder getInstanceAdminStubSettingsBuilder()

Returns
Type	Description
com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings.Builder

getSpannerStubSettingsBuilder()

public SpannerStubSettings.Builder getSpannerStubSettingsBuilder()

Returns
Type	Description
com.google.cloud.spanner.v1.stub.SpannerStubSettings.Builder

login(String arg0, char[] arg1)

public SpannerOptions.Builder login(String arg0, char[] arg1)

Parameters
Name	Description
arg0	String
arg1	char[]

Returns
Type	Description
SpannerOptions.Builder

setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider arg0)

public SpannerOptions.Builder setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider arg0)

Parameter
Name	Description
arg0	CloseableExecutorProvider

Returns
Type	Description
SpannerOptions.Builder

setAutoTaggingPackages(String[] arg0)

public SpannerOptions.Builder setAutoTaggingPackages(String[] arg0)

Parameter
Name	Description
arg0	String[]

Returns
Type	Description
SpannerOptions.Builder

setAutoTaggingPackages(List<String> arg0)

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

Parameter
Name	Description
arg0	List<String>

Returns
Type	Description
SpannerOptions.Builder

setAutoTaggingTracerLimit(int arg0)

public SpannerOptions.Builder setAutoTaggingTracerLimit(int arg0)

Parameter
Name	Description
arg0	int

Returns
Type	Description
SpannerOptions.Builder

setAutoThrottleAdministrativeRequests()

public SpannerOptions.Builder setAutoThrottleAdministrativeRequests()

Returns
Type	Description
SpannerOptions.Builder

setBuiltInMetricsEnabled(boolean arg0)

public SpannerOptions.Builder setBuiltInMetricsEnabled(boolean arg0)

Parameter
Name	Description
arg0	boolean

Returns
Type	Description
SpannerOptions.Builder

setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider arg0)

public SpannerOptions.Builder setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider arg0)

Parameter
Name	Description
arg0	CallCredentialsProvider

Returns
Type	Description
SpannerOptions.Builder

setChannelConfigurator(ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> arg0)

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

Parameter
Name	Description
arg0	ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder>

Returns
Type	Description
SpannerOptions.Builder

setChannelEndpointCacheFactory(ChannelEndpointCacheFactory arg0)

public SpannerOptions.Builder setChannelEndpointCacheFactory(ChannelEndpointCacheFactory arg0)

Internal Only: This feature is not stable for application use.

Parameter
Name	Description
arg0	com.google.cloud.spanner.spi.v1.ChannelEndpointCacheFactory

Returns
Type	Description
SpannerOptions.Builder

setChannelProvider(TransportChannelProvider arg0)

public SpannerOptions.Builder setChannelProvider(TransportChannelProvider arg0)

Parameter
Name	Description
arg0	TransportChannelProvider

Returns
Type	Description
SpannerOptions.Builder

setClientLibToken(String arg0)

public SpannerOptions.Builder setClientLibToken(String arg0)

Internal Only: This feature is not stable for application use.

Parameter
Name	Description
arg0	String

Returns
Type	Description
SpannerOptions.Builder

Overrides

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

setCompressorName(String arg0)

public SpannerOptions.Builder setCompressorName(String arg0)

Parameter
Name	Description
arg0	String

Returns
Type	Description
SpannerOptions.Builder

setDatabaseRole(String arg0)

public SpannerOptions.Builder setDatabaseRole(String arg0)

Parameter
Name	Description
arg0	String

Returns
Type	Description
SpannerOptions.Builder

setDecodeMode(DecodeMode arg0)

public SpannerOptions.Builder setDecodeMode(DecodeMode arg0)

Parameter
Name	Description
arg0	DecodeMode

Returns
Type	Description
SpannerOptions.Builder

setDefaultClientContext(RequestOptions.ClientContext arg0)

public SpannerOptions.Builder setDefaultClientContext(RequestOptions.ClientContext arg0)

Parameter
Name	Description
arg0	com.google.spanner.v1.RequestOptions.ClientContext

Returns
Type	Description
SpannerOptions.Builder

setDefaultQueryOptions(DatabaseId arg0, ExecuteSqlRequest.QueryOptions arg1)

public SpannerOptions.Builder setDefaultQueryOptions(DatabaseId arg0, ExecuteSqlRequest.QueryOptions arg1)

Parameters
Name	Description
arg0	DatabaseId
arg1	com.google.spanner.v1.ExecuteSqlRequest.QueryOptions

Returns
Type	Description
SpannerOptions.Builder

setDefaultTransactionOptions(SpannerOptions.Builder.DefaultReadWriteTransactionOptions arg0)

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

Parameter
Name	Description
arg0	DefaultReadWriteTransactionOptions

Returns
Type	Description
SpannerOptions.Builder

setDirectedReadOptions(DirectedReadOptions arg0)

public SpannerOptions.Builder setDirectedReadOptions(DirectedReadOptions arg0)

Parameter
Name	Description
arg0	com.google.spanner.v1.DirectedReadOptions

Returns
Type	Description
SpannerOptions.Builder

setEmulatorHost(String arg0)

public SpannerOptions.Builder setEmulatorHost(String arg0)

Parameter
Name	Description
arg0	String

Returns
Type	Description
SpannerOptions.Builder

setEnableApiTracing(boolean arg0)

public SpannerOptions.Builder setEnableApiTracing(boolean arg0)

Parameter
Name	Description
arg0	boolean

Returns
Type	Description
SpannerOptions.Builder

setEnableDirectAccess(boolean arg0)

public SpannerOptions.Builder setEnableDirectAccess(boolean arg0)

Beta

This feature is covered by the Pre-GA Offerings Terms 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
arg0	boolean

Returns
Type	Description
SpannerOptions.Builder

setEnableEndToEndTracing(boolean arg0)

public SpannerOptions.Builder setEnableEndToEndTracing(boolean arg0)

Parameter
Name	Description
arg0	boolean

Returns
Type	Description
SpannerOptions.Builder

setEnableExtendedTracing(boolean arg0)

public SpannerOptions.Builder setEnableExtendedTracing(boolean arg0)

Parameter
Name	Description
arg0	boolean

Returns
Type	Description
SpannerOptions.Builder

setExperimentalHost(String arg0) (deprecated)

public SpannerOptions.Builder setExperimentalHost(String arg0)

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.

Parameter
Name	Description
arg0	String

Returns
Type	Description
SpannerOptions.Builder

setGcpChannelPoolOptions(GcpManagedChannelOptions.GcpChannelPoolOptions arg0)

public SpannerOptions.Builder setGcpChannelPoolOptions(GcpManagedChannelOptions.GcpChannelPoolOptions arg0)

Parameter
Name	Description
arg0	com.google.cloud.grpc.GcpManagedChannelOptions.GcpChannelPoolOptions

Returns
Type	Description
SpannerOptions.Builder

setGrpcGcpOtelMetricsEnabled(boolean arg0)

public SpannerOptions.Builder setGrpcGcpOtelMetricsEnabled(boolean arg0)

Parameter
Name	Description
arg0	boolean

Returns
Type	Description
SpannerOptions.Builder

setGrpcKeepAliveTime(Duration arg0)

public SpannerOptions.Builder setGrpcKeepAliveTime(Duration arg0)

Parameter
Name	Description
arg0	Duration

Returns
Type	Description
SpannerOptions.Builder

setGrpcKeepAliveTimeout(Duration arg0)

public SpannerOptions.Builder setGrpcKeepAliveTimeout(Duration arg0)

Parameter
Name	Description
arg0	Duration

Returns
Type	Description
SpannerOptions.Builder

setHost(String arg0)

public SpannerOptions.Builder setHost(String arg0)

Parameter
Name	Description
arg0	String

Returns
Type	Description
SpannerOptions.Builder

Overrides

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

setInterceptorProvider(GrpcInterceptorProvider arg0)

public SpannerOptions.Builder setInterceptorProvider(GrpcInterceptorProvider arg0)

Parameter
Name	Description
arg0	GrpcInterceptorProvider

Returns
Type	Description
SpannerOptions.Builder

setMonitoringHost(String arg0) (deprecated)

public SpannerOptions.Builder setMonitoringHost(String arg0)

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.

Parameter
Name	Description
arg0	String

Returns
Type	Description
SpannerOptions.Builder

setNumChannels(int arg0)

public SpannerOptions.Builder setNumChannels(int arg0)

Parameter
Name	Description
arg0	int

Returns
Type	Description
SpannerOptions.Builder

setOpenTelemetry(OpenTelemetry arg0)

public SpannerOptions.Builder setOpenTelemetry(OpenTelemetry arg0)

Parameter
Name	Description
arg0	io.opentelemetry.api.OpenTelemetry

Returns
Type	Description
SpannerOptions.Builder

setPartitionedDmlTimeout(Duration arg0)

public SpannerOptions.Builder setPartitionedDmlTimeout(Duration arg0)

Obsolete

Use setPartitionedDmlTimeoutDuration(Duration) instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

Parameter
Name	Description
arg0	org.threeten.bp.Duration

Returns
Type	Description
SpannerOptions.Builder

setPartitionedDmlTimeoutDuration(Duration arg0)

public SpannerOptions.Builder setPartitionedDmlTimeoutDuration(Duration arg0)

Parameter
Name	Description
arg0	Duration

Returns
Type	Description
SpannerOptions.Builder

setPrefetchChunks(int arg0)

public SpannerOptions.Builder setPrefetchChunks(int arg0)

Parameter
Name	Description
arg0	int

Returns
Type	Description
SpannerOptions.Builder

setRetrySettings(RetrySettings arg0)

public SpannerOptions.Builder setRetrySettings(RetrySettings arg0)

Parameter
Name	Description
arg0	RetrySettings

Returns
Type	Description
SpannerOptions.Builder

Overrides

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

setSessionLabels(Map<String,String> arg0)

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

Parameter
Name	Description
arg0	Map<String,String>

Returns
Type	Description
SpannerOptions.Builder

setSessionPoolOption(SessionPoolOptions arg0)

public SpannerOptions.Builder setSessionPoolOption(SessionPoolOptions arg0)

Parameter
Name	Description
arg0	SessionPoolOptions

Returns
Type	Description
SpannerOptions.Builder

setTrackTransactionStarter()

public SpannerOptions.Builder setTrackTransactionStarter()

Returns
Type	Description
SpannerOptions.Builder

setTransportOptions(TransportOptions arg0)

public SpannerOptions.Builder setTransportOptions(TransportOptions arg0)

Parameter
Name	Description
arg0	com.google.cloud.TransportOptions

Returns
Type	Description
SpannerOptions.Builder

Overrides

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

setType(SpannerOptions.InstanceType arg0)

public SpannerOptions.Builder setType(SpannerOptions.InstanceType arg0)

Parameter
Name	Description
arg0	InstanceType

Returns
Type	Description
SpannerOptions.Builder

setUseVirtualThreads(boolean arg0)

protected SpannerOptions.Builder setUseVirtualThreads(boolean arg0)

Beta

This feature is covered by the Pre-GA Offerings Terms 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
arg0	boolean

Returns
Type	Description
SpannerOptions.Builder

useClientCert(String arg0, String arg1)

public SpannerOptions.Builder useClientCert(String arg0, String arg1)

Parameters
Name	Description
arg0	String
arg1	String

Returns
Type	Description
SpannerOptions.Builder

usePlainText()

public SpannerOptions.Builder usePlainText()

Returns
Type	Description
SpannerOptions.Builder