Class SpannerOptions (6.83.0)

public class SpannerOptions extends ServiceOptions<Spanner,SpannerOptions>

Options for the Cloud Spanner service.

Inheritance

java.lang.Object > com.google.cloud.ServiceOptions > SpannerOptions

Inherited Members

com.google.cloud.ServiceOptions.<B>toBuilder()

com.google.cloud.ServiceOptions.<T>getFromServiceLoader(java.lang.Class<? extends T>,T)

com.google.cloud.ServiceOptions.<T>newInstance(java.lang.String)

com.google.cloud.ServiceOptions.baseEquals(com.google.cloud.ServiceOptions<?,?>)

com.google.cloud.ServiceOptions.baseHashCode()

com.google.cloud.ServiceOptions.defaultRetrySettings()

com.google.cloud.ServiceOptions.getApiTracerFactory()

com.google.cloud.ServiceOptions.getAppEngineAppId()

com.google.cloud.ServiceOptions.getAppEngineProjectId()

com.google.cloud.ServiceOptions.getAppEngineProjectIdFromAppId()

com.google.cloud.ServiceOptions.getApplicationName()

com.google.cloud.ServiceOptions.getClientLibToken()

com.google.cloud.ServiceOptions.getClock()

com.google.cloud.ServiceOptions.getCredentials()

com.google.cloud.ServiceOptions.getDefaultHost()

com.google.cloud.ServiceOptions.getDefaultProject()

com.google.cloud.ServiceOptions.getDefaultProjectId()

com.google.cloud.ServiceOptions.getDefaultRetrySettings()

com.google.cloud.ServiceOptions.getGoogApiClientLibName()

com.google.cloud.ServiceOptions.getGoogleCloudProjectId()

com.google.cloud.ServiceOptions.getHost()

com.google.cloud.ServiceOptions.getLibraryName()

com.google.cloud.ServiceOptions.getLibraryVersion()

com.google.cloud.ServiceOptions.getMergedHeaderProvider(com.google.api.gax.rpc.HeaderProvider)

com.google.cloud.ServiceOptions.getNoRetrySettings()

com.google.cloud.ServiceOptions.getProjectId()

com.google.cloud.ServiceOptions.getQuotaProjectId()

com.google.cloud.ServiceOptions.getResolvedApiaryHost(java.lang.String)

com.google.cloud.ServiceOptions.getResolvedHost(java.lang.String)

com.google.cloud.ServiceOptions.getRetrySettings()

com.google.cloud.ServiceOptions.getRpc()

com.google.cloud.ServiceOptions.getScopedCredentials()

com.google.cloud.ServiceOptions.getScopes()

com.google.cloud.ServiceOptions.getService()

com.google.cloud.ServiceOptions.getServiceAccountProjectId()

com.google.cloud.ServiceOptions.getTransportOptions()

com.google.cloud.ServiceOptions.getUniverseDomain()

com.google.cloud.ServiceOptions.getUserAgent()

com.google.cloud.ServiceOptions.hasValidUniverseDomain()

com.google.cloud.ServiceOptions.projectIdRequired()

com.google.cloud.ServiceOptions.shouldRefreshRpc(com.google.cloud.ServiceRpc)

com.google.cloud.ServiceOptions.shouldRefreshService(ServiceT)

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)

Static Fields

CALL_CONTEXT_CONFIGURATOR_KEY

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

Context key for the CallContextConfigurator to use.

Field Value
Type	Description
`io.grpc.Context.Key<CallContextConfigurator>`

Static Methods

createAsyncExecutorProvider(int poolSize, long keepAliveTime, TimeUnit unit)

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

Creates a 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
Name	Description
`poolSize`	`int` the maximum number of threads to create in the pool
`keepAliveTime`	`long` the time that an unused thread in the pool should be kept alive
`unit`	`TimeUnit` the time unit used for the keepAliveTime

Returns
Type	Description
`SpannerOptions.CloseableExecutorProvider`	a CloseableExecutorProvider that can be used for SpannerOptions.Builder#setAsyncExecutorProvider(CloseableExecutorProvider)

disableOpenCensusMetrics()

public static void disableOpenCensusMetrics()

Disables OpenCensus metrics. Disable OpenCensus metrics before creating Spanner client.

enableOpenCensusTraces()

public static void enableOpenCensusTraces()

Enables OpenCensus traces. Enabling OpenCensus traces will disable OpenTelemetry traces.

enableOpenTelemetryMetrics()

public static void enableOpenTelemetryMetrics()

Enables OpenTelemetry metrics. Enable OpenTelemetry metrics before creating Spanner client.

enableOpenTelemetryTraces()

public static void enableOpenTelemetryTraces()

Enables OpenTelemetry traces. Enabling OpenTelemetry traces will disable OpenCensus traces. By default, OpenCensus traces are enabled.

getActiveTracingFramework()

public static SpannerOptions.TracingFramework getActiveTracingFramework()

Returns
Type	Description
`com.google.cloud.spanner.SpannerOptions.TracingFramework`

getDefaultGrpcTransportOptions()

public static GrpcTransportOptions getDefaultGrpcTransportOptions()

Returns
Type	Description
`com.google.cloud.grpc.GrpcTransportOptions`

getDefaultInstance()

public static SpannerOptions getDefaultInstance()

Returns default instance of SpannerOptions.

Returns
Type	Description
`SpannerOptions`

isEnabledOpenCensusMetrics()

public static boolean isEnabledOpenCensusMetrics()

Returns
Type	Description
`boolean`

isEnabledOpenTelemetryMetrics()

public static boolean isEnabledOpenTelemetryMetrics()

Returns
Type	Description
`boolean`

newBuilder()

public static SpannerOptions.Builder newBuilder()

Returns
Type	Description
`SpannerOptions.Builder`

useDefaultEnvironment()

public static void useDefaultEnvironment()

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

useEnvironment(SpannerOptions.SpannerEnvironment environment)

public static void useEnvironment(SpannerOptions.SpannerEnvironment environment)

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

Parameter
Name	Description
`environment`	`SpannerOptions.SpannerEnvironment`

Constructors

SpannerOptions(SpannerOptions.Builder builder)

protected SpannerOptions(SpannerOptions.Builder builder)

Parameter
Name	Description
`builder`	`SpannerOptions.Builder`

Methods

getApiTracerFactory()

public ApiTracerFactory getApiTracerFactory()

Returns
Type	Description
`ApiTracerFactory`

Overrides

com.google.cloud.ServiceOptions.getApiTracerFactory()

getApiTracerFactory(boolean isAdminClient, boolean isEmulatorEnabled)

public ApiTracerFactory getApiTracerFactory(boolean isAdminClient, boolean isEmulatorEnabled)

Parameters
Name	Description
`isAdminClient`	`boolean`
`isEmulatorEnabled`	`boolean`

Returns
Type	Description
`ApiTracerFactory`

getAsyncExecutorProvider()

public SpannerOptions.CloseableExecutorProvider getAsyncExecutorProvider()

Returns
Type	Description
`SpannerOptions.CloseableExecutorProvider`

getCallCredentialsProvider()

public SpannerOptions.CallCredentialsProvider getCallCredentialsProvider()

Returns
Type	Description
`SpannerOptions.CallCredentialsProvider`

getChannelConfigurator()

public ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> getChannelConfigurator()

Returns
Type	Description
`ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder>`

getChannelProvider()

public TransportChannelProvider getChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getCompressorName()

public String getCompressorName()

Returns
Type	Description
`String`

getDatabaseAdminStubSettings()

public DatabaseAdminStubSettings getDatabaseAdminStubSettings()

Returns
Type	Description
`DatabaseAdminStubSettings`

getDatabaseRole()

public String getDatabaseRole()

Returns
Type	Description
`String`

getDecodeMode()

public DecodeMode getDecodeMode()

Returns
Type	Description
`DecodeMode`

getDefaultHost()

protected String getDefaultHost()

Returns
Type	Description
`String`

Overrides

com.google.cloud.ServiceOptions.getDefaultHost()

getDefaultProject()

protected String getDefaultProject()

Returns
Type	Description
`String`

Overrides

com.google.cloud.ServiceOptions.getDefaultProject()

getDefaultQueryOptions(DatabaseId databaseId)

public ExecuteSqlRequest.QueryOptions getDefaultQueryOptions(DatabaseId databaseId)

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

Parameter
Name	Description
`databaseId`	`DatabaseId`

Returns
Type	Description
`ExecuteSqlRequest.QueryOptions`

getDirectedReadOptions()

public DirectedReadOptions getDirectedReadOptions()

Returns
Type	Description
`DirectedReadOptions`

getEndpoint()

public String getEndpoint()

Returns
Type	Description
`String`

getGrpcGcpOptions()

public GcpManagedChannelOptions getGrpcGcpOptions()

Returns
Type	Description
`com.google.cloud.grpc.GcpManagedChannelOptions`

getInstanceAdminStubSettings()

public InstanceAdminStubSettings getInstanceAdminStubSettings()

Returns
Type	Description
`InstanceAdminStubSettings`

getInterceptorProvider()

public GrpcInterceptorProvider getInterceptorProvider()

Returns
Type	Description
`GrpcInterceptorProvider`

getNumChannels()

public int getNumChannels()

Returns
Type	Description
`int`

getOpenTelemetry()

public OpenTelemetry getOpenTelemetry()

Returns an instance of OpenTelemetry. If OpenTelemetry object is not set via SpannerOptions then GlobalOpenTelemetry will be used as fallback.

Returns
Type	Description
`io.opentelemetry.api.OpenTelemetry`

getPartitionedDmlTimeout()

public Duration getPartitionedDmlTimeout()

Returns
Type	Description
`org.threeten.bp.Duration`

getPartitionedDmlTimeoutDuration()

public Duration getPartitionedDmlTimeoutDuration()

Returns
Type	Description
`Duration`

getPrefetchChunks()

public int getPrefetchChunks()

Returns
Type	Description
`int`

getRetryAdministrativeRequestsSettings()

public RetrySettings getRetryAdministrativeRequestsSettings()

Returns
Type	Description
`RetrySettings`

getScopes()

public Set<String> getScopes()

Returns
Type	Description
`Set<String>`

Overrides

com.google.cloud.ServiceOptions.getScopes()

getSessionLabels()

public Map<String,String> getSessionLabels()

Returns
Type	Description
`Map<String,String>`

getSessionPoolOptions()

public SessionPoolOptions getSessionPoolOptions()

Returns
Type	Description
`SessionPoolOptions`

getSpannerRpcV1()

protected SpannerRpc getSpannerRpcV1()

Returns
Type	Description
`SpannerRpc`

getSpannerStubSettings()

public SpannerStubSettings getSpannerStubSettings()

Returns
Type	Description
`SpannerStubSettings`

getTransportChannelExecutorThreadNameFormat()

public String getTransportChannelExecutorThreadNameFormat()

Returns
Type	Description
`String`

isAttemptDirectPath()

public boolean isAttemptDirectPath()

Returns
Type	Description
`boolean`

isAutoThrottleAdministrativeRequests()

public boolean isAutoThrottleAdministrativeRequests()

Returns
Type	Description
`boolean`

isEnableApiTracing()

public boolean isEnableApiTracing()

Returns true if an com.google.api.gax.tracing.ApiTracer should be created and set on the Spanner client. Enabling this only has effect if an OpenTelemetry or OpenCensus trace exporter has been configured.

Returns
Type	Description
`boolean`

isEnableBuiltInMetrics()

public boolean isEnableBuiltInMetrics()

Returns true if an com.google.api.gax.tracing.MetricsTracer should be created and set on the Spanner client.

Returns
Type	Description
`boolean`

isEnableExtendedTracing()

public boolean isEnableExtendedTracing()

Returns whether extended OpenTelemetry tracing is enabled. Enabling this option will add the following additional attributes to the traces that are generated by the client:

db.statement: Contains the SQL statement that is being executed.
thread.name: The name of the thread that executes the statement.

Returns
Type	Description
`boolean`

isEndToEndTracingEnabled()

public boolean isEndToEndTracingEnabled()

Returns whether end to end tracing is enabled. If this option is enabled then trace spans will be created at the Spanner layer.

Returns
Type	Description
`boolean`

isGrpcGcpExtensionEnabled()

public boolean isGrpcGcpExtensionEnabled()

Returns
Type	Description
`boolean`

isLeaderAwareRoutingEnabled()

public boolean isLeaderAwareRoutingEnabled()

Returns
Type	Description
`boolean`

isTrackTransactionStarter()

public boolean isTrackTransactionStarter()

Returns
Type	Description
`boolean`

isUseVirtualThreads()

public boolean isUseVirtualThreads()

Returns
Type	Description
`boolean`

shouldRefreshRpc(ServiceRpc cachedRpc)

protected boolean shouldRefreshRpc(ServiceRpc cachedRpc)

Parameter
Name	Description
`cachedRpc`	`com.google.cloud.ServiceRpc`

Returns
Type	Description
`boolean`	`true` if the cached ServiceRpc instance is `null` or closed. This will cause the method #getRpc() to create a new Spanner instance when one is requested.

Overrides

com.google.cloud.ServiceOptions.shouldRefreshRpc(com.google.cloud.ServiceRpc)

shouldRefreshService(Spanner cachedService)

protected boolean shouldRefreshService(Spanner cachedService)

Parameter
Name	Description
`cachedService`	`Spanner`

Returns
Type	Description
`boolean`	`true` if the cached Spanner service instance is `null` or closed. This will cause the method #getService() to create a new SpannerRpc instance when one is requested.

Overrides

com.google.cloud.ServiceOptions.shouldRefreshService(ServiceT)

toBuilder()

public SpannerOptions.Builder toBuilder()

Returns
Type	Description
`SpannerOptions.Builder`

Overrides

com.google.cloud.ServiceOptions.<B>toBuilder()