Class SpannerSettings.Builder (6.120.0)

public static class SpannerSettings.Builder extends ClientSettings.Builder<SpannerSettings,SpannerSettings.Builder>

Builder for SpannerSettings.

Inheritance

java.lang.Object > ClientSettings.Builder > SpannerSettings.Builder

Constructors

Builder()

protected Builder()

Builder(@Nullable ClientContext clientContext)

protected Builder(@Nullable ClientContext clientContext)
Parameter
Name Description
clientContext @org.jspecify.annotations.Nullable com.google.api.gax.rpc.ClientContext

Builder(SpannerSettings settings)

protected Builder(SpannerSettings settings)
Parameter
Name Description
settings SpannerSettings

Builder(SpannerStubSettings.Builder stubSettings)

protected Builder(SpannerStubSettings.Builder stubSettings)
Parameter
Name Description
stubSettings SpannerStubSettings.Builder

Methods

applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

public SpannerSettings.Builder applyToAllUnaryMethods(ApiFunction<UnaryCallSettings.Builder<?,?>,Void> settingsUpdater)

Applies the given settings updater function to all of the unary API methods in this service.

Note: This method does not support applying settings to streaming methods.

Parameter
Name Description
settingsUpdater ApiFunction<Builder<?,?>,Void>
Returns
Type Description
SpannerSettings.Builder

batchCreateSessionsSettings()

public UnaryCallSettings.Builder<BatchCreateSessionsRequest,BatchCreateSessionsResponse> batchCreateSessionsSettings()

Returns the builder for the settings used for calls to batchCreateSessions.

Returns
Type Description
Builder<BatchCreateSessionsRequest,BatchCreateSessionsResponse>

batchWriteSettings()

public ServerStreamingCallSettings.Builder<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()

Returns the builder for the settings used for calls to batchWrite.

Returns
Type Description
Builder<BatchWriteRequest,BatchWriteResponse>

beginTransactionSettings()

public UnaryCallSettings.Builder<BeginTransactionRequest,Transaction> beginTransactionSettings()

Returns the builder for the settings used for calls to beginTransaction.

Returns
Type Description
Builder<BeginTransactionRequest,Transaction>

build()

public SpannerSettings build()
Returns
Type Description
SpannerSettings
Overrides
Exceptions
Type Description
IOException

commitSettings()

public UnaryCallSettings.Builder<CommitRequest,CommitResponse> commitSettings()

Returns the builder for the settings used for calls to commit.

Returns
Type Description
Builder<CommitRequest,CommitResponse>

createSessionSettings()

public UnaryCallSettings.Builder<CreateSessionRequest,Session> createSessionSettings()

Returns the builder for the settings used for calls to createSession.

Returns
Type Description
Builder<CreateSessionRequest,Session>

deleteSessionSettings()

public UnaryCallSettings.Builder<DeleteSessionRequest,Empty> deleteSessionSettings()

Returns the builder for the settings used for calls to deleteSession.

Returns
Type Description
Builder<DeleteSessionRequest,Empty>

executeBatchDmlSettings()

public UnaryCallSettings.Builder<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse> executeBatchDmlSettings()

Returns the builder for the settings used for calls to executeBatchDml.

Returns
Type Description
Builder<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse>

executeSqlSettings()

public UnaryCallSettings.Builder<ExecuteSqlRequest,ResultSet> executeSqlSettings()

Returns the builder for the settings used for calls to executeSql.

Returns
Type Description
Builder<ExecuteSqlRequest,ResultSet>

executeStreamingSqlSettings()

public ServerStreamingCallSettings.Builder<ExecuteSqlRequest,PartialResultSet> executeStreamingSqlSettings()

Returns the builder for the settings used for calls to executeStreamingSql.

Returns
Type Description
Builder<ExecuteSqlRequest,PartialResultSet>

fetchCacheUpdateSettings()

public ServerStreamingCallSettings.Builder<FetchCacheUpdateRequest,CacheUpdate> fetchCacheUpdateSettings()

Returns the builder for the settings used for calls to fetchCacheUpdate.

Returns
Type Description
Builder<FetchCacheUpdateRequest,CacheUpdate>

getSessionSettings()

public UnaryCallSettings.Builder<GetSessionRequest,Session> getSessionSettings()

Returns the builder for the settings used for calls to getSession.

Returns
Type Description
Builder<GetSessionRequest,Session>

getStubSettingsBuilder()

public SpannerStubSettings.Builder getStubSettingsBuilder()
Returns
Type Description
SpannerStubSettings.Builder

listSessionsSettings()

public PagedCallSettings.Builder<ListSessionsRequest,ListSessionsResponse,SpannerClient.ListSessionsPagedResponse> listSessionsSettings()

Returns the builder for the settings used for calls to listSessions.

Returns
Type Description
Builder<ListSessionsRequest,ListSessionsResponse,ListSessionsPagedResponse>

partitionQuerySettings()

public UnaryCallSettings.Builder<PartitionQueryRequest,PartitionResponse> partitionQuerySettings()

Returns the builder for the settings used for calls to partitionQuery.

Returns
Type Description
Builder<PartitionQueryRequest,PartitionResponse>

partitionReadSettings()

public UnaryCallSettings.Builder<PartitionReadRequest,PartitionResponse> partitionReadSettings()

Returns the builder for the settings used for calls to partitionRead.

Returns
Type Description
Builder<PartitionReadRequest,PartitionResponse>

readSettings()

public UnaryCallSettings.Builder<ReadRequest,ResultSet> readSettings()

Returns the builder for the settings used for calls to read.

Returns
Type Description
Builder<ReadRequest,ResultSet>

rollbackSettings()

public UnaryCallSettings.Builder<RollbackRequest,Empty> rollbackSettings()

Returns the builder for the settings used for calls to rollback.

Returns
Type Description
Builder<RollbackRequest,Empty>

streamingReadSettings()

public ServerStreamingCallSettings.Builder<ReadRequest,PartialResultSet> streamingReadSettings()

Returns the builder for the settings used for calls to streamingRead.

Returns
Type Description
Builder<ReadRequest,PartialResultSet>