SpannerOptions (Google Cloud 0.101.0-alpha API)

java.lang.Object
- com.google.cloud.ServiceOptions<Spanner,SpannerOptions>
- - com.google.cloud.spanner.SpannerOptions

All Implemented Interfaces:

Serializable
```
public class SpannerOptions
extends 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.

Nested Classes
Modifier and Type	Class and Description
`static class`	`SpannerOptions.Builder` Builder for `SpannerOptions` instances.

Field Summary
- Fields inherited from class com.google.cloud.ServiceOptions
  CREDENTIAL_ENV_NAME, credentials

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.core.ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder>`	`getChannelConfigurator()`
`com.google.api.gax.rpc.TransportChannelProvider`	`getChannelProvider()`
`DatabaseAdminStubSettings`	`getDatabaseAdminStubSettings()`
`static GrpcTransportOptions`	`getDefaultGrpcTransportOptions()`
`protected String`	`getDefaultHost()`
`static SpannerOptions`	`getDefaultInstance()` Returns default instance of `SpannerOptions`.
`String`	`getEndpoint()`
`InstanceAdminStubSettings`	`getInstanceAdminStubSettings()`
`com.google.api.gax.grpc.GrpcInterceptorProvider`	`getInterceptorProvider()`
`int`	`getNumChannels()`
`org.threeten.bp.Duration`	`getPartitionedDmlTimeout()`
`int`	`getPrefetchChunks()`
`Set<String>`	`getScopes()`
`Map<String,String>`	`getSessionLabels()`
`SessionPoolOptions`	`getSessionPoolOptions()`
`protected SpannerRpc`	`getSpannerRpcV1()`
`SpannerStubSettings`	`getSpannerStubSettings()`
`static SpannerOptions.Builder`	`newBuilder()`
`protected boolean`	`shouldRefreshRpc(ServiceRpc cachedRpc)`
`protected boolean`	`shouldRefreshService(Spanner cachedService)`
`SpannerOptions.Builder`	`toBuilder()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - getDefaultInstance
```
public static SpannerOptions getDefaultInstance()
```
    Returns default instance of SpannerOptions.
  - newBuilder
```
public static SpannerOptions.Builder newBuilder()
```
  - getChannelProvider
```
public com.google.api.gax.rpc.TransportChannelProvider getChannelProvider()
```
  - getChannelConfigurator
```
public com.google.api.core.ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> getChannelConfigurator()
```
  - getInterceptorProvider
```
public com.google.api.gax.grpc.GrpcInterceptorProvider getInterceptorProvider()
```
  - getNumChannels
```
public int getNumChannels()
```
  - 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()
```
  - getPrefetchChunks
```
public int getPrefetchChunks()
```
  - getDefaultGrpcTransportOptions
```
public static GrpcTransportOptions getDefaultGrpcTransportOptions()
```
  - getDefaultHost
```
protected String getDefaultHost()
```
    Overrides:
    
    getDefaultHost in class ServiceOptions<Spanner,SpannerOptions>
  - getScopes
```
public Set<String> getScopes()
```
    Specified by:
    
    getScopes in class ServiceOptions<Spanner,SpannerOptions>
  - getSpannerRpcV1
```
protected SpannerRpc getSpannerRpcV1()
```
  - shouldRefreshService
```
protected boolean shouldRefreshService(Spanner cachedService)
```
    Overrides:
    
    shouldRefreshService in class ServiceOptions<Spanner,SpannerOptions>
    
    Parameters:
    
    cachedService - The currently cached service object
    
    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(ServiceRpc cachedRpc)
```
    Overrides:
    
    shouldRefreshRpc in class ServiceOptions<Spanner,SpannerOptions>
    
    Parameters:
    
    cachedRpc - The currently cached service object
    
    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 ServiceOptions<Spanner,SpannerOptions>
  - getEndpoint
```
public String getEndpoint()
```

Class SpannerOptions

Nested Class Summary

Field Summary

Fields inherited from class com.google.cloud.ServiceOptions

Method Summary

Methods inherited from class com.google.cloud.ServiceOptions

Methods inherited from class java.lang.Object

Method Detail

getDefaultInstance

newBuilder

getChannelProvider

getChannelConfigurator

getInterceptorProvider

getNumChannels

getSessionPoolOptions

getSessionLabels

getSpannerStubSettings

getInstanceAdminStubSettings

getDatabaseAdminStubSettings

getPartitionedDmlTimeout

getPrefetchChunks

getDefaultGrpcTransportOptions

getDefaultHost

getScopes

getSpannerRpcV1

shouldRefreshService

shouldRefreshRpc

toBuilder

getEndpoint