Class SpannerOptions (2.33.1)

Version latest

• 2.33.1 (latest)
• 2.33.0
• 2.32.3
• 2.31.2
• 2.30.4
• 2.28.0
• 2.27.1
• 2.26.1
• 2.25.1
• 2.24.1
• 2.23.0
• 2.22.1
• 2.21.0
• 2.20.2
• 2.19.3
• 2.18.1
• 2.17.0
• 2.16.1
• 2.15.5
• 2.14.6
• 2.13.4
• 2.11.4
• 2.10.0
• 2.9.16
• 2.8.0
• 2.7.12
• 2.6.4
• 2.5.11

public class SpannerOptions extends ServiceOptions<Spanner,SpannerOptions>

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

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

Static Methods

createAsyncExecutorProvider(int arg0, long arg1, TimeUnit arg2)

public static SpannerOptions.CloseableExecutorProvider createAsyncExecutorProvider(int arg0, long arg1, TimeUnit arg2)

Parameters
Name	Description
arg0	int
arg1	long
arg2	TimeUnit

Returns
Type	Description
CloseableExecutorProvider

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

getDefaultExperimentalCredentialsFromSysEnv()

public static GoogleCredentials getDefaultExperimentalCredentialsFromSysEnv()

Internal Only: This feature is not stable for application use.

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

getDefaultGrpcTransportOptions()

public static GrpcTransportOptions getDefaultGrpcTransportOptions()

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

getDefaultInstance()

public static SpannerOptions getDefaultInstance()

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
Builder

useDefaultEnvironment()

public static void useDefaultEnvironment()

useEnvironment(SpannerOptions.SpannerEnvironment arg0)

public static void useEnvironment(SpannerOptions.SpannerEnvironment arg0)

Parameter
Name	Description
arg0	SpannerEnvironment

Constructors

SpannerOptions(SpannerOptions.Builder arg0)

protected SpannerOptions(SpannerOptions.Builder arg0)

Parameter
Name	Description
arg0	Builder

Methods

enablegRPCMetrics(InstantiatingGrpcChannelProvider.Builder arg0)

public void enablegRPCMetrics(InstantiatingGrpcChannelProvider.Builder arg0)

Parameter
Name	Description
arg0	Builder

getApiTracerFactory()

public ApiTracerFactory getApiTracerFactory()

Returns
Type	Description
ApiTracerFactory

Overrides

com.google.cloud.ServiceOptions.getApiTracerFactory()

getApiTracerFactory(boolean arg0, boolean arg1)

public ApiTracerFactory getApiTracerFactory(boolean arg0, boolean arg1)

Parameters
Name	Description
arg0	boolean
arg1	boolean

Returns
Type	Description
ApiTracerFactory

getAsyncExecutorProvider()

public SpannerOptions.CloseableExecutorProvider getAsyncExecutorProvider()

Returns
Type	Description
CloseableExecutorProvider

getCallCredentialsProvider()

public SpannerOptions.CallCredentialsProvider getCallCredentialsProvider()

Returns
Type	Description
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
com.google.cloud.spanner.admin.database.v1.stub.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 arg0)

public ExecuteSqlRequest.QueryOptions getDefaultQueryOptions(DatabaseId arg0)

Parameter
Name	Description
arg0	DatabaseId

Returns
Type	Description
com.google.spanner.v1.ExecuteSqlRequest.QueryOptions

getDefaultTransactionOptions()

public TransactionOptions getDefaultTransactionOptions()

Returns
Type	Description
com.google.spanner.v1.TransactionOptions

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

Returns
Type	Description
GrpcInterceptorProvider

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

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
com.google.cloud.spanner.spi.v1.SpannerRpc

getSpannerStubSettings()

public SpannerStubSettings getSpannerStubSettings()

Returns
Type	Description
com.google.cloud.spanner.v1.stub.SpannerStubSettings

getTransportChannelExecutorThreadNameFormat()

public String getTransportChannelExecutorThreadNameFormat()

Returns
Type	Description
String

isAttemptDirectPath() (deprecated)

public boolean isAttemptDirectPath()

Obsolete

Use isEnableDirectAccess() instead

This feature is stable for usage in this major version, but may be deprecated in a future release.

Returns
Type	Description
boolean

isAutoThrottleAdministrativeRequests()

public boolean isAutoThrottleAdministrativeRequests()

Returns
Type	Description
boolean

isEnableApiTracing()

public boolean isEnableApiTracing()

Returns
Type	Description
boolean

isEnableBuiltInMetrics()

public boolean isEnableBuiltInMetrics()

Returns
Type	Description
boolean

isEnableDirectAccess()

public Boolean isEnableDirectAccess()

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.

Returns
Type	Description
Boolean

isEnableExtendedTracing()

public boolean isEnableExtendedTracing()

Returns
Type	Description
boolean

isEndToEndTracingEnabled()

public boolean isEndToEndTracingEnabled()

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

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.

Returns
Type	Description
boolean

shouldRefreshRpc(ServiceRpc arg0)

protected boolean shouldRefreshRpc(ServiceRpc arg0)

Parameter
Name	Description
arg0	com.google.cloud.ServiceRpc

Returns
Type	Description
boolean

Overrides

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

shouldRefreshService(Spanner arg0)

protected boolean shouldRefreshService(Spanner arg0)

Parameter
Name	Description
arg0	Spanner

Returns
Type	Description
boolean

Overrides

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

toBuilder()

public SpannerOptions.Builder toBuilder()

Returns
Type	Description
Builder

Overrides

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