Class SpannerOptions (2.17.0) 

public class SpannerOptions extends ServiceOptions<Spanner,SpannerOptions>

Inheritance

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

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

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

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

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

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

public boolean isAttemptDirectPath()
Returns
Type Description
boolean

isAutoThrottleAdministrativeRequests()

public boolean isAutoThrottleAdministrativeRequests()
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 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()