Class SpannerOptions (6.89.0)
Stay organized with collections Save and categorize content based on your preferences.

publicclassSpannerOptionsextendsServiceOptions<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.wait(long,int)

Static Fields

CALL_CONTEXT_CONFIGURATOR_KEY

publicstaticfinalContext.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)

publicstaticSpannerOptions.CloseableExecutorProvidercreateAsyncExecutorProvider(intpoolSize,longkeepAliveTime,TimeUnitunit)

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()

publicstaticvoiddisableOpenCensusMetrics()

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

enableOpenCensusTraces()

publicstaticvoidenableOpenCensusTraces()

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

enableOpenTelemetryMetrics()

publicstaticvoidenableOpenTelemetryMetrics()

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

enableOpenTelemetryTraces()

publicstaticvoidenableOpenTelemetryTraces()

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

getActiveTracingFramework()

publicstaticSpannerOptions.TracingFrameworkgetActiveTracingFramework()

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

getDefaultExperimentalCredentialsFromSysEnv()

publicstaticGoogleCredentialsgetDefaultExperimentalCredentialsFromSysEnv()

Returns
Type	Description
`com.google.auth.oauth2.GoogleCredentials`

getDefaultGrpcTransportOptions()

publicstaticGrpcTransportOptionsgetDefaultGrpcTransportOptions()

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

getDefaultInstance()

publicstaticSpannerOptionsgetDefaultInstance()

Returns default instance of SpannerOptions.

Returns
Type	Description
`SpannerOptions`

isEnabledOpenCensusMetrics()

publicstaticbooleanisEnabledOpenCensusMetrics()

Returns
Type	Description
`boolean`

isEnabledOpenTelemetryMetrics()

publicstaticbooleanisEnabledOpenTelemetryMetrics()

Returns
Type	Description
`boolean`

newBuilder()

publicstaticSpannerOptions.BuildernewBuilder()

Returns
Type	Description
`SpannerOptions.Builder`

useDefaultEnvironment()

publicstaticvoiduseDefaultEnvironment()

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

useEnvironment(SpannerOptions.SpannerEnvironment environment)

publicstaticvoiduseEnvironment(SpannerOptions.SpannerEnvironmentenvironment)

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)

protectedSpannerOptions(SpannerOptions.Builderbuilder)

Parameter
Name	Description
`builder`	`SpannerOptions.Builder`

Methods

getApiTracerFactory()

publicApiTracerFactorygetApiTracerFactory()

Returns
Type	Description
`ApiTracerFactory`

Overrides

com.google.cloud.ServiceOptions.getApiTracerFactory()

getApiTracerFactory(boolean isAdminClient, boolean isEmulatorEnabled)

publicApiTracerFactorygetApiTracerFactory(booleanisAdminClient,booleanisEmulatorEnabled)

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

Returns
Type	Description
`ApiTracerFactory`

getAsyncExecutorProvider()

publicSpannerOptions.CloseableExecutorProvidergetAsyncExecutorProvider()

Returns
Type	Description
`SpannerOptions.CloseableExecutorProvider`

getCallCredentialsProvider()

publicSpannerOptions.CallCredentialsProvidergetCallCredentialsProvider()

Returns
Type	Description
`SpannerOptions.CallCredentialsProvider`

getChannelConfigurator()

publicApiFunction<ManagedChannelBuilder,ManagedChannelBuilder>getChannelConfigurator()

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

getChannelProvider()

publicTransportChannelProvidergetChannelProvider()

Returns
Type	Description
`TransportChannelProvider`

getCompressorName()

publicStringgetCompressorName()

Returns
Type	Description
`String`

getDatabaseAdminStubSettings()

publicDatabaseAdminStubSettingsgetDatabaseAdminStubSettings()

Returns
Type	Description
`DatabaseAdminStubSettings`

getDatabaseRole()

publicStringgetDatabaseRole()

Returns
Type	Description
`String`

getDecodeMode()

publicDecodeModegetDecodeMode()

Returns
Type	Description
`DecodeMode`

getDefaultHost()

protectedStringgetDefaultHost()

Returns
Type	Description
`String`

Overrides

com.google.cloud.ServiceOptions.getDefaultHost()

getDefaultProject()

protectedStringgetDefaultProject()

Returns
Type	Description
`String`

Overrides

com.google.cloud.ServiceOptions.getDefaultProject()

getDefaultQueryOptions(DatabaseId databaseId)

publicExecuteSqlRequest.QueryOptionsgetDefaultQueryOptions(DatabaseIddatabaseId)

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

Parameter
Name	Description
`databaseId`	`DatabaseId`

Returns
Type	Description
`ExecuteSqlRequest.QueryOptions`

getDefaultTransactionOptions()

publicTransactionOptionsgetDefaultTransactionOptions()

Returns
Type	Description
`TransactionOptions`

getDirectedReadOptions()

publicDirectedReadOptionsgetDirectedReadOptions()

Returns
Type	Description
`DirectedReadOptions`

getEndpoint()

publicStringgetEndpoint()

Returns
Type	Description
`String`

getGrpcGcpOptions()

publicGcpManagedChannelOptionsgetGrpcGcpOptions()

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

getInstanceAdminStubSettings()

publicInstanceAdminStubSettingsgetInstanceAdminStubSettings()

Returns
Type	Description
`InstanceAdminStubSettings`

getInterceptorProvider()

publicGrpcInterceptorProvidergetInterceptorProvider()

Returns
Type	Description
`GrpcInterceptorProvider`

getNumChannels()

publicintgetNumChannels()

Returns
Type	Description
`int`

getOpenTelemetry()

publicOpenTelemetrygetOpenTelemetry()

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()

publicDurationgetPartitionedDmlTimeout()

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

getPartitionedDmlTimeoutDuration()

publicDurationgetPartitionedDmlTimeoutDuration()

Returns
Type	Description
`Duration`

getPrefetchChunks()

publicintgetPrefetchChunks()

Returns
Type	Description
`int`

getRetryAdministrativeRequestsSettings()

publicRetrySettingsgetRetryAdministrativeRequestsSettings()

Returns
Type	Description
`RetrySettings`

getScopes()

publicSet<String>getScopes()

Returns
Type	Description
`Set<String>`

Overrides

com.google.cloud.ServiceOptions.getScopes()

getSessionLabels()

publicMap<String,String>getSessionLabels()

Returns
Type	Description
`Map<String,String>`

getSessionPoolOptions()

publicSessionPoolOptionsgetSessionPoolOptions()

Returns
Type	Description
`SessionPoolOptions`

getSpannerRpcV1()

protectedSpannerRpcgetSpannerRpcV1()

Returns
Type	Description
`SpannerRpc`

getSpannerStubSettings()

publicSpannerStubSettingsgetSpannerStubSettings()

Returns
Type	Description
`SpannerStubSettings`

getTransportChannelExecutorThreadNameFormat()

publicStringgetTransportChannelExecutorThreadNameFormat()

Returns
Type	Description
`String`

isAttemptDirectPath()

publicbooleanisAttemptDirectPath()

Returns
Type	Description
`boolean`

isAutoThrottleAdministrativeRequests()

publicbooleanisAutoThrottleAdministrativeRequests()

Returns
Type	Description
`boolean`

isEnableApiTracing()

publicbooleanisEnableApiTracing()

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()

publicbooleanisEnableBuiltInMetrics()

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

Returns
Type	Description
`boolean`

isEnableExtendedTracing()

publicbooleanisEnableExtendedTracing()

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()

publicbooleanisEndToEndTracingEnabled()

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()

publicbooleanisGrpcGcpExtensionEnabled()

Returns
Type	Description
`boolean`

isLeaderAwareRoutingEnabled()

publicbooleanisLeaderAwareRoutingEnabled()

Returns
Type	Description
`boolean`

isTrackTransactionStarter()

publicbooleanisTrackTransactionStarter()

Returns
Type	Description
`boolean`

isUseVirtualThreads()

publicbooleanisUseVirtualThreads()

Returns
Type	Description
`boolean`

shouldRefreshRpc(ServiceRpc cachedRpc)

protectedbooleanshouldRefreshRpc(ServiceRpccachedRpc)

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)

protectedbooleanshouldRefreshService(SpannercachedService)

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()

publicSpannerOptions.BuildertoBuilder()

Returns
Type	Description
`SpannerOptions.Builder`

Overrides

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

Class SpannerOptions (6.89.0) Stay organized with collections Save and categorize content based on your preferences.

Inheritance

Inherited Members

Static Fields

CALL_CONTEXT_CONFIGURATOR_KEY

Static Methods

createAsyncExecutorProvider(int poolSize, long keepAliveTime, TimeUnit unit)

disableOpenCensusMetrics()

enableOpenCensusTraces()

enableOpenTelemetryMetrics()

enableOpenTelemetryTraces()

getActiveTracingFramework()

getDefaultExperimentalCredentialsFromSysEnv()

getDefaultGrpcTransportOptions()

getDefaultInstance()

isEnabledOpenCensusMetrics()

isEnabledOpenTelemetryMetrics()

newBuilder()

useDefaultEnvironment()

useEnvironment(SpannerOptions.SpannerEnvironment environment)

Constructors

SpannerOptions(SpannerOptions.Builder builder)

Methods

getApiTracerFactory()

getApiTracerFactory(boolean isAdminClient, boolean isEmulatorEnabled)

getAsyncExecutorProvider()

getCallCredentialsProvider()

getChannelConfigurator()

getChannelProvider()

getCompressorName()

getDatabaseAdminStubSettings()

getDatabaseRole()

getDecodeMode()

getDefaultHost()

getDefaultProject()

getDefaultQueryOptions(DatabaseId databaseId)

getDefaultTransactionOptions()

getDirectedReadOptions()

getEndpoint()

getGrpcGcpOptions()

getInstanceAdminStubSettings()

getInterceptorProvider()

getNumChannels()

getOpenTelemetry()

getPartitionedDmlTimeout()

getPartitionedDmlTimeoutDuration()

getPrefetchChunks()

getRetryAdministrativeRequestsSettings()

getScopes()

getSessionLabels()

getSessionPoolOptions()

getSpannerRpcV1()

getSpannerStubSettings()

getTransportChannelExecutorThreadNameFormat()

isAttemptDirectPath()

isAutoThrottleAdministrativeRequests()

isEnableApiTracing()

isEnableBuiltInMetrics()

isEnableExtendedTracing()

isEndToEndTracingEnabled()

isGrpcGcpExtensionEnabled()

isLeaderAwareRoutingEnabled()

isTrackTransactionStarter()

isUseVirtualThreads()

shouldRefreshRpc(ServiceRpc cachedRpc)

shouldRefreshService(Spanner cachedService)

toBuilder()

Class SpannerOptions (6.89.0)
Stay organized with collections Save and categorize content based on your preferences.