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.

Field Summary

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

credentials

Method Summary

Modifier and Type	Method and Description
SpannerOptions	build()
SpannerOptions.Builder	setChannelProvider(TransportChannelProvider channelProvider) Sets the ChannelProvider.
SpannerOptions.Builder	setInterceptorProvider(GrpcInterceptorProvider interceptorProvider) Sets the GrpcInterceptorProvider.
SpannerOptions.Builder	setNumChannels(int numChannels) Sets the number of gRPC channels to use.
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	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	setTransportOptions(TransportOptions transportOptions) Sets the transport options.

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

self, setClock, setCredentials, setHeaderProvider, setHost, setProjectId, setRetrySettings, setServiceFactory, setServiceRpcFactory

Methods inherited from class java.lang.Object

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

Method Detail

setTransportOptions

public SpannerOptions.Builder setTransportOptions(TransportOptions transportOptions)

Description copied from class: ServiceOptions.Builder

Sets the transport options.

Overrides:

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

Returns:

the builder

setChannelProvider

public SpannerOptions.Builder setChannelProvider(TransportChannelProvider channelProvider)

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

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.

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 .

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 overriden on a per read/query basis by Options.prefetchChunks(). If unspecified, we will use a default value (currently 4).

build

public SpannerOptions build()

Specified by:

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