Send feedback
Class SpannerOptions.Builder (2.26.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.26.0 keyboard_arrow_down
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)
Constructors
Builder()
Methods
build()
public SpannerOptions build ()
Overrides
com.google.cloud.ServiceOptions.Builder.build()
disableAdministrativeRequestRetries()
public SpannerOptions . Builder disableAdministrativeRequestRetries ()
disableDirectPath()
public SpannerOptions . Builder disableDirectPath ()
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.
disableGrpcGcpExtension()
public SpannerOptions . Builder disableGrpcGcpExtension ()
disableLeaderAwareRouting()
public SpannerOptions . Builder disableLeaderAwareRouting ()
enableGrpcGcpExtension()
public SpannerOptions . Builder enableGrpcGcpExtension ()
enableGrpcGcpExtension(GcpManagedChannelOptions arg0)
public SpannerOptions . Builder enableGrpcGcpExtension ( GcpManagedChannelOptions arg0 )
Parameter
Name Description
arg0com.google.cloud.grpc.GcpManagedChannelOptions
enableLeaderAwareRouting()
public SpannerOptions . Builder enableLeaderAwareRouting ()
getAllowedClientLibTokens()
protected Set<String> getAllowedClientLibTokens ()
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
setAsyncExecutorProvider(SpannerOptions.CloseableExecutorProvider arg0)
public SpannerOptions . Builder setAsyncExecutorProvider ( SpannerOptions . CloseableExecutorProvider arg0 )
setAutoThrottleAdministrativeRequests()
public SpannerOptions . Builder setAutoThrottleAdministrativeRequests ()
setBuiltInMetricsEnabled(boolean arg0)
public SpannerOptions . Builder setBuiltInMetricsEnabled ( boolean arg0 )
Parameter
Name Description
arg0boolean
setCallCredentialsProvider(SpannerOptions.CallCredentialsProvider arg0)
public SpannerOptions . Builder setCallCredentialsProvider ( SpannerOptions . CallCredentialsProvider arg0 )
setChannelConfigurator(ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> arg0)
public SpannerOptions . Builder setChannelConfigurator ( ApiFunction<ManagedChannelBuilder , ManagedChannelBuilder > arg0 )
Parameter
Name Description
arg0ApiFunction <io.grpc.ManagedChannelBuilder ,io.grpc.ManagedChannelBuilder >
setChannelProvider(TransportChannelProvider arg0)
public SpannerOptions . Builder setChannelProvider ( TransportChannelProvider arg0 )
setClientLibToken(String arg0)
public SpannerOptions . Builder setClientLibToken ( String arg0 )
Parameter
Name Description
arg0String
Overrides
com.google.cloud.ServiceOptions.Builder.setClientLibToken(java.lang.String)
setCompressorName(String arg0)
public SpannerOptions . Builder setCompressorName ( String arg0 )
Parameter
Name Description
arg0String
setDatabaseRole(String arg0)
public SpannerOptions . Builder setDatabaseRole ( String arg0 )
Parameter
Name Description
arg0String
setDecodeMode(DecodeMode arg0)
public SpannerOptions . Builder setDecodeMode ( DecodeMode arg0 )
setDefaultQueryOptions(DatabaseId arg0, ExecuteSqlRequest.QueryOptions arg1)
public SpannerOptions . Builder setDefaultQueryOptions ( DatabaseId arg0 , ExecuteSqlRequest . QueryOptions arg1 )
Parameters
Name Description
arg0DatabaseId
arg1com.google.spanner.v1.ExecuteSqlRequest.QueryOptions
setDirectedReadOptions(DirectedReadOptions arg0)
public SpannerOptions . Builder setDirectedReadOptions ( DirectedReadOptions arg0 )
Parameter
Name Description
arg0com.google.spanner.v1.DirectedReadOptions
setEmulatorHost(String arg0)
public SpannerOptions . Builder setEmulatorHost ( String arg0 )
Parameter
Name Description
arg0String
setEnableApiTracing(boolean arg0)
public SpannerOptions . Builder setEnableApiTracing ( boolean arg0 )
Parameter
Name Description
arg0boolean
setEnableEndToEndTracing(boolean arg0)
public SpannerOptions . Builder setEnableEndToEndTracing ( boolean arg0 )
Parameter
Name Description
arg0boolean
setEnableExtendedTracing(boolean arg0)
public SpannerOptions . Builder setEnableExtendedTracing ( boolean arg0 )
Parameter
Name Description
arg0boolean
setHost(String arg0)
public SpannerOptions . Builder setHost ( String arg0 )
Parameter
Name Description
arg0String
Overrides
com.google.cloud.ServiceOptions.Builder.setHost(java.lang.String)
setInterceptorProvider(GrpcInterceptorProvider arg0)
public SpannerOptions . Builder setInterceptorProvider ( GrpcInterceptorProvider arg0 )
setMonitoringHost(String arg0)
public SpannerOptions . Builder setMonitoringHost ( String arg0 )
Parameter
Name Description
arg0String
setNumChannels(int arg0)
public SpannerOptions . Builder setNumChannels ( int arg0 )
Parameter
Name Description
arg0int
setOpenTelemetry(OpenTelemetry arg0)
public SpannerOptions . Builder setOpenTelemetry ( OpenTelemetry arg0 )
Parameter
Name Description
arg0io.opentelemetry.api.OpenTelemetry
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
arg0org.threeten.bp.Duration
setPartitionedDmlTimeoutDuration(Duration arg0)
public SpannerOptions . Builder setPartitionedDmlTimeoutDuration ( Duration arg0 )
Parameter
Name Description
arg0Duration
setPrefetchChunks(int arg0)
public SpannerOptions . Builder setPrefetchChunks ( int arg0 )
Parameter
Name Description
arg0int
setRetrySettings(RetrySettings arg0)
public SpannerOptions . Builder setRetrySettings ( RetrySettings arg0 )
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 )
setSessionPoolOption(SessionPoolOptions arg0)
public SpannerOptions . Builder setSessionPoolOption ( SessionPoolOptions arg0 )
setTrackTransactionStarter()
public SpannerOptions . Builder setTrackTransactionStarter ()
setTransportOptions(TransportOptions arg0)
public SpannerOptions . Builder setTransportOptions ( TransportOptions arg0 )
Parameter
Name Description
arg0com.google.cloud.TransportOptions
Overrides
com.google.cloud.ServiceOptions.Builder.setTransportOptions(com.google.cloud.TransportOptions)
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
arg0boolean
useClientCert(String arg0, String arg1)
public SpannerOptions . Builder useClientCert ( String arg0 , String arg1 )
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-04 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-04 UTC."],[],[]]
