com.google.cloud.spanner

Class SpannerOptions

java.lang.Object

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

com.google.cloud.spanner.SpannerOptions

All Implemented Interfaces:

Serializable

public class SpannerOptions
extends com.google.cloud.ServiceOptions<Spanner,SpannerOptions>

Options for the Cloud Spanner service.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpannerOptions.Builder Builder for SpannerOptions instances.
static interface	SpannerOptions.CallContextConfigurator SpannerOptions.CallContextConfigurator can be used to modify the ApiCallContext for one or more specific RPCs.
static interface	SpannerOptions.CallCredentialsProvider Interface that can be used to provide CallCredentials instead of Credentials to SpannerOptions.
static interface	SpannerOptions.CloseableExecutorProvider ExecutorProvider that is used for AsyncResultSet.
static class	SpannerOptions.FixedCloseableExecutorProvider Implementation of SpannerOptions.CloseableExecutorProvider that uses a fixed single ScheduledExecutorService.
static class	SpannerOptions.SpannerCallContextTimeoutConfigurator Helper class to configure timeouts for specific Spanner RPCs.
static interface	SpannerOptions.SpannerEnvironment The environment to read configuration values from.

Field Summary

Fields

Modifier and Type	Field and Description
static Context.Key<SpannerOptions.CallContextConfigurator>	CALL_CONTEXT_CONFIGURATOR_KEY Context key for the SpannerOptions.CallContextConfigurator to use.

Fields inherited from class com.google.cloud.ServiceOptions

clientLibToken, CREDENTIAL_ENV_NAME, credentials

Method Summary

Modifier and Type	Method and Description
static SpannerOptions.CloseableExecutorProvider	createAsyncExecutorProvider(int poolSize, long keepAliveTime, TimeUnit unit) Creates a SpannerOptions.CloseableExecutorProvider that can be used as an ExecutorProvider for the async API.
SpannerOptions.CloseableExecutorProvider	getAsyncExecutorProvider()
SpannerOptions.CallCredentialsProvider	getCallCredentialsProvider()
com.google.api.core.ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder>	getChannelConfigurator()
TransportChannelProvider	getChannelProvider()
String	getCompressorName()
DatabaseAdminStubSettings	getDatabaseAdminStubSettings()
static com.google.cloud.grpc.GrpcTransportOptions	getDefaultGrpcTransportOptions()
protected String	getDefaultHost()
static SpannerOptions	getDefaultInstance() Returns default instance of SpannerOptions.
protected String	getDefaultProject()
ExecuteSqlRequest.QueryOptions	getDefaultQueryOptions(DatabaseId databaseId) Returns the default query options to use for the specific database.
String	getEndpoint()
com.google.cloud.grpc.GcpManagedChannelOptions	getGrpcGcpOptions()
InstanceAdminStubSettings	getInstanceAdminStubSettings()
GrpcInterceptorProvider	getInterceptorProvider()
int	getNumChannels()
org.threeten.bp.Duration	getPartitionedDmlTimeout()
int	getPrefetchChunks()
RetrySettings	getRetryAdministrativeRequestsSettings()
Set<String>	getScopes()
Map<String,String>	getSessionLabels()
SessionPoolOptions	getSessionPoolOptions()
protected SpannerRpc	getSpannerRpcV1()
SpannerStubSettings	getSpannerStubSettings()
String	getTransportChannelExecutorThreadNameFormat()
boolean	isAutoThrottleAdministrativeRequests()
boolean	isGrpcGcpExtensionEnabled()
boolean	isTrackTransactionStarter()
static SpannerOptions.Builder	newBuilder()
protected boolean	shouldRefreshRpc(com.google.cloud.ServiceRpc cachedRpc)
protected boolean	shouldRefreshService(Spanner cachedService)
SpannerOptions.Builder	toBuilder()
static void	useDefaultEnvironment() Sets the environment to use to read configuration to the default environment.
static void	useEnvironment(SpannerOptions.SpannerEnvironment environment) Sets the environment to use to read configuration.

Methods inherited from class com.google.cloud.ServiceOptions

baseEquals, baseHashCode, defaultRetrySettings, getAppEngineAppId, getAppEngineProjectId, getAppEngineProjectIdFromAppId, getApplicationName, getClientLibToken, getClock, getCredentials, getDefaultProjectId, getDefaultRetrySettings, getFromServiceLoader, getGoogApiClientLibName, getGoogleCloudProjectId, getHost, getLibraryName, getLibraryVersion, getMergedHeaderProvider, getNoRetrySettings, getProjectId, getQuotaProjectId, getRetrySettings, getRpc, getScopedCredentials, getService, getServiceAccountProjectId, getTransportOptions, getUserAgent, newInstance, projectIdRequired

Methods inherited from class java.lang.Object

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

Field Detail

CALL_CONTEXT_CONFIGURATOR_KEY

public static final Context.Key<SpannerOptions.CallContextConfigurator> CALL_CONTEXT_CONFIGURATOR_KEY

Context key for the SpannerOptions.CallContextConfigurator to use.

Method Detail

createAsyncExecutorProvider

public static SpannerOptions.CloseableExecutorProvider createAsyncExecutorProvider(int poolSize,
                                                                                   long keepAliveTime,
                                                                                   TimeUnit unit)

Creates a SpannerOptions.CloseableExecutorProvider that can be used as an ExecutorProvider for the async API. The ExecutorProvider will lazily create up to poolSize threads. The backing threads will automatically be shutdown if they have not been used during the keep-alive time. The backing threads are created as daemon threads.

Parameters:

poolSize - the maximum number of threads to create in the pool

keepAliveTime - the time that an unused thread in the pool should be kept alive

unit - the time unit used for the keepAliveTime

Returns:

a SpannerOptions.CloseableExecutorProvider that can be used for SpannerOptions.Builder#setAsyncExecutorProvider(CloseableExecutorProvider)

getDefaultInstance

public static SpannerOptions getDefaultInstance()

Returns default instance of SpannerOptions.

newBuilder

public static SpannerOptions.Builder newBuilder()

useEnvironment

public static void useEnvironment(SpannerOptions.SpannerEnvironment environment)

Sets the environment to use to read configuration. The default will read configuration from environment variables.

useDefaultEnvironment

public static void useDefaultEnvironment()

Sets the environment to use to read configuration to the default environment. This will read configuration from environment variables.

getDefaultProject

protected String getDefaultProject()

Overrides:

getDefaultProject in class com.google.cloud.ServiceOptions<Spanner,SpannerOptions>

getChannelProvider

public TransportChannelProvider getChannelProvider()

getChannelConfigurator

public com.google.api.core.ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> getChannelConfigurator()

getInterceptorProvider

public GrpcInterceptorProvider getInterceptorProvider()

getNumChannels

public int getNumChannels()

getTransportChannelExecutorThreadNameFormat

public String getTransportChannelExecutorThreadNameFormat()

getSessionPoolOptions

public SessionPoolOptions getSessionPoolOptions()

getSessionLabels

public Map<String,String> getSessionLabels()

getSpannerStubSettings

public SpannerStubSettings getSpannerStubSettings()

getInstanceAdminStubSettings

public InstanceAdminStubSettings getInstanceAdminStubSettings()

getDatabaseAdminStubSettings

public DatabaseAdminStubSettings getDatabaseAdminStubSettings()

getPartitionedDmlTimeout

public org.threeten.bp.Duration getPartitionedDmlTimeout()

isGrpcGcpExtensionEnabled

public boolean isGrpcGcpExtensionEnabled()

getGrpcGcpOptions

public com.google.cloud.grpc.GcpManagedChannelOptions getGrpcGcpOptions()

isAutoThrottleAdministrativeRequests

public boolean isAutoThrottleAdministrativeRequests()

getRetryAdministrativeRequestsSettings

public RetrySettings getRetryAdministrativeRequestsSettings()

isTrackTransactionStarter

public boolean isTrackTransactionStarter()

getCallCredentialsProvider

public SpannerOptions.CallCredentialsProvider getCallCredentialsProvider()

getCompressorName

public String getCompressorName()

getDefaultQueryOptions

public ExecuteSqlRequest.QueryOptions getDefaultQueryOptions(DatabaseId databaseId)

Returns the default query options to use for the specific database.

getAsyncExecutorProvider

public SpannerOptions.CloseableExecutorProvider getAsyncExecutorProvider()

getPrefetchChunks

public int getPrefetchChunks()

getDefaultGrpcTransportOptions

public static com.google.cloud.grpc.GrpcTransportOptions getDefaultGrpcTransportOptions()

getDefaultHost

protected String getDefaultHost()

Overrides:

getDefaultHost in class com.google.cloud.ServiceOptions<Spanner,SpannerOptions>

getScopes

public Set<String> getScopes()

Specified by:

getScopes in class com.google.cloud.ServiceOptions<Spanner,SpannerOptions>

getSpannerRpcV1

protected SpannerRpc getSpannerRpcV1()

shouldRefreshService

protected boolean shouldRefreshService(Spanner cachedService)

Overrides:

shouldRefreshService in class com.google.cloud.ServiceOptions<Spanner,SpannerOptions>

Returns:

true if the cached Spanner service instance is null or closed. This will cause the method ServiceOptions.getService() to create a new SpannerRpc instance when one is requested.

shouldRefreshRpc

protected boolean shouldRefreshRpc(com.google.cloud.ServiceRpc cachedRpc)

Overrides:

shouldRefreshRpc in class com.google.cloud.ServiceOptions<Spanner,SpannerOptions>

Returns:

true if the cached ServiceRpc instance is null or closed. This will cause the method ServiceOptions.getRpc() to create a new Spanner instance when one is requested.

toBuilder

public SpannerOptions.Builder toBuilder()

Specified by:

toBuilder in class com.google.cloud.ServiceOptions<Spanner,SpannerOptions>

getEndpoint

public String getEndpoint()