public class SpannerOptions extends ServiceOptions<Spanner,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)
Static Fields
CALL_CONTEXT_CONFIGURATOR_KEY
public static final Context.Key<SpannerOptions.CallContextConfigurator> CALL_CONTEXT_CONFIGURATOR_KEY
Static Methods
createAsyncExecutorProvider(int arg0, long arg1, TimeUnit arg2)
public static SpannerOptions.CloseableExecutorProvider createAsyncExecutorProvider(int arg0, long arg1, TimeUnit arg2)
disableOpenCensusMetrics()
public static void disableOpenCensusMetrics()
enableOpenCensusTraces()
public static void enableOpenCensusTraces()
Obsolete
The OpenCensus project is deprecated. Use enableOpenTelemetryTraces to switch to OpenTelemetry traces
This feature is stable for usage in this major version, but may be deprecated in a future release.
enableOpenTelemetryMetrics()
public static void enableOpenTelemetryMetrics()
enableOpenTelemetryTraces()
public static void enableOpenTelemetryTraces()
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()
isEnabledOpenCensusMetrics()
public static boolean isEnabledOpenCensusMetrics()
isEnabledOpenTelemetryMetrics()
public static boolean isEnabledOpenTelemetryMetrics()
newBuilder()
public static SpannerOptions.Builder newBuilder()
useDefaultEnvironment()
public static void useDefaultEnvironment()
useEnvironment(SpannerOptions.SpannerEnvironment arg0)
public static void useEnvironment(SpannerOptions.SpannerEnvironment arg0)
Constructors
SpannerOptions(SpannerOptions.Builder arg0)
protected SpannerOptions(SpannerOptions.Builder arg0)
Parameter
Name
Description
arg0
Builder
Methods
getApiTracerFactory()
public ApiTracerFactory getApiTracerFactory()
Overrides
com.google.cloud.ServiceOptions.getApiTracerFactory()
getAsyncExecutorProvider()
public SpannerOptions.CloseableExecutorProvider getAsyncExecutorProvider()
getCallCredentialsProvider()
public SpannerOptions.CallCredentialsProvider getCallCredentialsProvider()
getChannelConfigurator()
public ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> getChannelConfigurator()
Returns
Type
Description
ApiFunction <io.grpc.ManagedChannelBuilder ,io.grpc.ManagedChannelBuilder >
getChannelProvider()
public TransportChannelProvider getChannelProvider()
getCompressorName()
public String getCompressorName()
Returns
Type
Description
String
getDatabaseAdminStubSettings()
public DatabaseAdminStubSettings getDatabaseAdminStubSettings()
Returns
Type
Description
com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings
getDatabaseRole()
public String getDatabaseRole()
Returns
Type
Description
String
getDecodeMode()
public DecodeMode getDecodeMode()
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 arg0)
public ExecuteSqlRequest.QueryOptions getDefaultQueryOptions(DatabaseId arg0)
Returns
Type
Description
com.google.spanner.v1.ExecuteSqlRequest.QueryOptions
getDirectedReadOptions()
public DirectedReadOptions getDirectedReadOptions()
Returns
Type
Description
com.google.spanner.v1.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
com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings
getInterceptorProvider()
public GrpcInterceptorProvider getInterceptorProvider()
getNumChannels()
public int getNumChannels()
Returns
Type
Description
int
getOpenTelemetry()
public OpenTelemetry getOpenTelemetry()
Returns
Type
Description
io.opentelemetry.api.OpenTelemetry
getPartitionedDmlTimeout()
public Duration getPartitionedDmlTimeout()
Returns
Type
Description
org.threeten.bp.Duration
getPrefetchChunks()
public int getPrefetchChunks()
Returns
Type
Description
int
getRetryAdministrativeRequestsSettings()
public RetrySettings getRetryAdministrativeRequestsSettings()
getScopes()
public Set<String> getScopes()
Overrides
com.google.cloud.ServiceOptions.getScopes()
getSessionLabels()
public Map<String,String> getSessionLabels()
getSessionPoolOptions()
public SessionPoolOptions getSessionPoolOptions()
getSpannerRpcV1()
protected SpannerRpc getSpannerRpcV1()
Returns
Type
Description
com.google.cloud.spanner.spi.v1.SpannerRpc
getSpannerStubSettings()
public SpannerStubSettings getSpannerStubSettings()
Returns
Type
Description
com.google.cloud.spanner.v1.stub.SpannerStubSettings
public String getTransportChannelExecutorThreadNameFormat()
Returns
Type
Description
String
isAttemptDirectPath()
public boolean isAttemptDirectPath()
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
isAutoThrottleAdministrativeRequests()
public boolean isAutoThrottleAdministrativeRequests()
isEnableApiTracing()
public boolean isEnableApiTracing()
isEnableExtendedTracing()
public boolean isEnableExtendedTracing()
isGrpcGcpExtensionEnabled()
public boolean isGrpcGcpExtensionEnabled()
isLeaderAwareRoutingEnabled()
public boolean isLeaderAwareRoutingEnabled()
isTrackTransactionStarter()
public boolean isTrackTransactionStarter()
isUseVirtualThreads()
public boolean isUseVirtualThreads()
Beta
This feature is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.
shouldRefreshRpc(ServiceRpc arg0)
protected boolean shouldRefreshRpc(ServiceRpc arg0)
Parameter
Name
Description
arg0
com.google.cloud.ServiceRpc
Overrides
com.google.cloud.ServiceOptions.shouldRefreshRpc(com.google.cloud.ServiceRpc)
shouldRefreshService(Spanner arg0)
protected boolean shouldRefreshService(Spanner arg0)
Parameter
Name
Description
arg0
Spanner
Overrides
com.google.cloud.ServiceOptions.shouldRefreshService(ServiceT)
toBuilder()
public SpannerOptions.Builder toBuilder()
Overrides
com.google.cloud.ServiceOptions.<B>toBuilder()