Class SpannerSettings

public class SpannerSettings extends ClientSettings<SpannerSettings>

Settings class to configure an instance of SpannerClient.

The default instance has everything set to sensible defaults:

The default service address (spanner.googleapis.com) and default port (443) are used.
Credentials are acquired automatically through Application Default Credentials.
Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of createSession to 30 seconds:


 SpannerSettings.Builder spannerSettingsBuilder = SpannerSettings.newBuilder();
 spannerSettingsBuilder
     .createSessionSettings()
     .setRetrySettings(
         spannerSettingsBuilder
             .createSessionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SpannerSettings spannerSettings = spannerSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > SpannerSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Constructors

SpannerSettings(SpannerSettings.Builder settingsBuilder)

protected SpannerSettings(SpannerSettings.Builder settingsBuilder)

Parameter

Name	Description
settingsBuilder	`SpannerSettings.Builder`

Methods

batchCreateSessionsSettings()

public UnaryCallSettings<BatchCreateSessionsRequest,BatchCreateSessionsResponse> batchCreateSessionsSettings()

Returns the object with the settings used for calls to batchCreateSessions.

Returns

Type	Description
UnaryCallSettings<BatchCreateSessionsRequest,BatchCreateSessionsResponse>

beginTransactionSettings()

public UnaryCallSettings<BeginTransactionRequest,Transaction> beginTransactionSettings()

Returns the object with the settings used for calls to beginTransaction.

Returns

Type	Description
UnaryCallSettings<BeginTransactionRequest,Transaction>

commitSettings()

public UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()

Returns the object with the settings used for calls to commit.

Returns

Type	Description
UnaryCallSettings<CommitRequest,CommitResponse>

create(SpannerStubSettings stub)

public static final SpannerSettings create(SpannerStubSettings stub)

Parameter

Name	Description
stub	`SpannerStubSettings`

Returns

Type	Description
SpannerSettings

Exceptions

Type	Description
IOException

createSessionSettings()

public UnaryCallSettings<CreateSessionRequest,Session> createSessionSettings()

Returns the object with the settings used for calls to createSession.

Returns

Type	Description
UnaryCallSettings<CreateSessionRequest,Session>

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

Returns

Type	Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns

Type	Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns

Type	Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns

Type	Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()

Returns

Type	Description
TransportChannelProvider

deleteSessionSettings()

public UnaryCallSettings<DeleteSessionRequest,Empty> deleteSessionSettings()

Returns the object with the settings used for calls to deleteSession.

Returns

Type	Description
UnaryCallSettings<DeleteSessionRequest,Empty>

executeBatchDmlSettings()

public UnaryCallSettings<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse> executeBatchDmlSettings()

Returns the object with the settings used for calls to executeBatchDml.

Returns

Type	Description
UnaryCallSettings<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse>

executeSqlSettings()

public UnaryCallSettings<ExecuteSqlRequest,ResultSet> executeSqlSettings()

Returns the object with the settings used for calls to executeSql.

Returns

Type	Description
UnaryCallSettings<ExecuteSqlRequest,ResultSet>

executeStreamingSqlSettings()

public ServerStreamingCallSettings<ExecuteSqlRequest,PartialResultSet> executeStreamingSqlSettings()

Returns the object with the settings used for calls to executeStreamingSql.

Returns

Type	Description
ServerStreamingCallSettings<ExecuteSqlRequest,PartialResultSet>

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns

Type	Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns

Type	Description
List<String>

getSessionSettings()

public UnaryCallSettings<GetSessionRequest,Session> getSessionSettings()

Returns the object with the settings used for calls to getSession.

Returns

Type	Description
UnaryCallSettings<GetSessionRequest,Session>

listSessionsSettings()

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

Returns the object with the settings used for calls to listSessions.

Returns

Type	Description
PagedCallSettings<ListSessionsRequest,ListSessionsResponse,ListSessionsPagedResponse>

newBuilder()

public static SpannerSettings.Builder newBuilder()

Returns a new builder for this class.

Returns

Type	Description
SpannerSettings.Builder

newBuilder(ClientContext clientContext)

public static SpannerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter

Name	Description
clientContext	`ClientContext`

Returns

Type	Description
SpannerSettings.Builder

partitionQuerySettings()

public UnaryCallSettings<PartitionQueryRequest,PartitionResponse> partitionQuerySettings()

Returns the object with the settings used for calls to partitionQuery.

Returns

Type	Description
UnaryCallSettings<PartitionQueryRequest,PartitionResponse>

partitionReadSettings()

public UnaryCallSettings<PartitionReadRequest,PartitionResponse> partitionReadSettings()

Returns the object with the settings used for calls to partitionRead.

Returns

Type	Description
UnaryCallSettings<PartitionReadRequest,PartitionResponse>

readSettings()

public UnaryCallSettings<ReadRequest,ResultSet> readSettings()

Returns the object with the settings used for calls to read.

Returns

Type	Description
UnaryCallSettings<ReadRequest,ResultSet>

rollbackSettings()

public UnaryCallSettings<RollbackRequest,Empty> rollbackSettings()

Returns the object with the settings used for calls to rollback.

Returns

Type	Description
UnaryCallSettings<RollbackRequest,Empty>

streamingReadSettings()

public ServerStreamingCallSettings<ReadRequest,PartialResultSet> streamingReadSettings()

Returns the object with the settings used for calls to streamingRead.

Returns

Type	Description
ServerStreamingCallSettings<ReadRequest,PartialResultSet>

toBuilder()

public SpannerSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns

Type	Description
SpannerSettings.Builder

Overrides

ClientSettings<SettingsT>.<B>toBuilder()