Class SpannerOptions (2.15.5)

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
TypeDescription
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
NameDescription
arg0int
arg1long
arg2TimeUnit
Returns
TypeDescription
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
TypeDescription
com.google.cloud.spanner.SpannerOptions.TracingFramework

getDefaultGrpcTransportOptions()

public static GrpcTransportOptions getDefaultGrpcTransportOptions()
Returns
TypeDescription
com.google.cloud.grpc.GrpcTransportOptions

getDefaultInstance()

public static SpannerOptions getDefaultInstance()
Returns
TypeDescription
SpannerOptions

isEnabledOpenCensusMetrics()

public static boolean isEnabledOpenCensusMetrics()
Returns
TypeDescription
boolean

isEnabledOpenTelemetryMetrics()

public static boolean isEnabledOpenTelemetryMetrics()
Returns
TypeDescription
boolean

newBuilder()

public static SpannerOptions.Builder newBuilder()
Returns
TypeDescription
Builder

useDefaultEnvironment()

public static void useDefaultEnvironment()

useEnvironment(SpannerOptions.SpannerEnvironment arg0)

public static void useEnvironment(SpannerOptions.SpannerEnvironment arg0)
Parameter
NameDescription
arg0SpannerEnvironment

Constructors

SpannerOptions(SpannerOptions.Builder arg0)

protected SpannerOptions(SpannerOptions.Builder arg0)
Parameter
NameDescription
arg0Builder

Methods

getAsyncExecutorProvider()

public SpannerOptions.CloseableExecutorProvider getAsyncExecutorProvider()
Returns
TypeDescription
CloseableExecutorProvider

getCallCredentialsProvider()

public SpannerOptions.CallCredentialsProvider getCallCredentialsProvider()
Returns
TypeDescription
CallCredentialsProvider

getChannelConfigurator()

public ApiFunction<ManagedChannelBuilder,ManagedChannelBuilder> getChannelConfigurator()
Returns
TypeDescription
ApiFunction<io.grpc.ManagedChannelBuilder,io.grpc.ManagedChannelBuilder>

getChannelProvider()

public TransportChannelProvider getChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getCompressorName()

public String getCompressorName()
Returns
TypeDescription
String

getDatabaseAdminStubSettings()

public DatabaseAdminStubSettings getDatabaseAdminStubSettings()
Returns
TypeDescription
com.google.cloud.spanner.admin.database.v1.stub.DatabaseAdminStubSettings

getDatabaseRole()

public String getDatabaseRole()
Returns
TypeDescription
String

getDecodeMode()

public DecodeMode getDecodeMode()
Returns
TypeDescription
DecodeMode

getDefaultHost()

protected String getDefaultHost()
Returns
TypeDescription
String
Overrides
com.google.cloud.ServiceOptions.getDefaultHost()

getDefaultProject()

protected String getDefaultProject()
Returns
TypeDescription
String
Overrides
com.google.cloud.ServiceOptions.getDefaultProject()

getDefaultQueryOptions(DatabaseId arg0)

public ExecuteSqlRequest.QueryOptions getDefaultQueryOptions(DatabaseId arg0)
Parameter
NameDescription
arg0DatabaseId
Returns
TypeDescription
com.google.spanner.v1.ExecuteSqlRequest.QueryOptions

getDirectedReadOptions()

public DirectedReadOptions getDirectedReadOptions()
Returns
TypeDescription
com.google.spanner.v1.DirectedReadOptions

getEndpoint()

public String getEndpoint()
Returns
TypeDescription
String

getGrpcGcpOptions()

public GcpManagedChannelOptions getGrpcGcpOptions()
Returns
TypeDescription
com.google.cloud.grpc.GcpManagedChannelOptions

getInstanceAdminStubSettings()

public InstanceAdminStubSettings getInstanceAdminStubSettings()
Returns
TypeDescription
com.google.cloud.spanner.admin.instance.v1.stub.InstanceAdminStubSettings

getInterceptorProvider()

public GrpcInterceptorProvider getInterceptorProvider()
Returns
TypeDescription
GrpcInterceptorProvider

getNumChannels()

public int getNumChannels()
Returns
TypeDescription
int

getOpenTelemetry()

public OpenTelemetry getOpenTelemetry()
Returns
TypeDescription
io.opentelemetry.api.OpenTelemetry

getPartitionedDmlTimeout()

public Duration getPartitionedDmlTimeout()
Returns
TypeDescription
org.threeten.bp.Duration

getPrefetchChunks()

public int getPrefetchChunks()
Returns
TypeDescription
int

getRetryAdministrativeRequestsSettings()

public RetrySettings getRetryAdministrativeRequestsSettings()
Returns
TypeDescription
RetrySettings

getScopes()

public Set<String> getScopes()
Returns
TypeDescription
Set<String>
Overrides
com.google.cloud.ServiceOptions.getScopes()

getSessionLabels()

public Map<String,String> getSessionLabels()
Returns
TypeDescription
Map<String,String>

getSessionPoolOptions()

public SessionPoolOptions getSessionPoolOptions()
Returns
TypeDescription
SessionPoolOptions

getSpannerRpcV1()

protected SpannerRpc getSpannerRpcV1()
Returns
TypeDescription
com.google.cloud.spanner.spi.v1.SpannerRpc

getSpannerStubSettings()

public SpannerStubSettings getSpannerStubSettings()
Returns
TypeDescription
com.google.cloud.spanner.v1.stub.SpannerStubSettings

getTransportChannelExecutorThreadNameFormat()

public String getTransportChannelExecutorThreadNameFormat()
Returns
TypeDescription
String

isAttemptDirectPath()

public boolean isAttemptDirectPath()
Returns
TypeDescription
boolean

isAutoThrottleAdministrativeRequests()

public boolean isAutoThrottleAdministrativeRequests()
Returns
TypeDescription
boolean

isGrpcGcpExtensionEnabled()

public boolean isGrpcGcpExtensionEnabled()
Returns
TypeDescription
boolean

isLeaderAwareRoutingEnabled()

public boolean isLeaderAwareRoutingEnabled()
Returns
TypeDescription
boolean

isTrackTransactionStarter()

public boolean isTrackTransactionStarter()
Returns
TypeDescription
boolean

isUseVirtualThreads()

public boolean isUseVirtualThreads()
Returns
TypeDescription
boolean

shouldRefreshRpc(ServiceRpc arg0)

protected boolean shouldRefreshRpc(ServiceRpc arg0)
Parameter
NameDescription
arg0com.google.cloud.ServiceRpc
Returns
TypeDescription
boolean
Overrides
com.google.cloud.ServiceOptions.shouldRefreshRpc(com.google.cloud.ServiceRpc)

shouldRefreshService(Spanner arg0)

protected boolean shouldRefreshService(Spanner arg0)
Parameter
NameDescription
arg0Spanner
Returns
TypeDescription
boolean
Overrides
com.google.cloud.ServiceOptions.shouldRefreshService(ServiceT)

toBuilder()

public SpannerOptions.Builder toBuilder()
Returns
TypeDescription
Builder
Overrides
com.google.cloud.ServiceOptions.<B>toBuilder()