Package com.google.cloud.spanner.v1
Class SpannerSettings
@Generated("by gapic-generator-java")
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 [RetrySettings](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of createSession:
// This snippet has been automatically generated and should be regarded as a code template only.
// It will require modifications to work:
// - It may require correct/in-range values for request initialization.
// - It may require specifying regional endpoints when creating the service client as shown in
// https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
SpannerSettings.Builder spannerSettingsBuilder = SpannerSettings.newBuilder();
spannerSettingsBuilder
.createSessionSettings()
.setRetrySettings(
spannerSettingsBuilder
.createSessionSettings()
.getRetrySettings()
.toBuilder()
.setInitialRetryDelayDuration(Duration.ofSeconds(1))
.setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
.setMaxAttempts(5)
.setMaxRetryDelayDuration(Duration.ofSeconds(30))
.setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
.setRetryDelayMultiplier(1.3)
.setRpcTimeoutMultiplier(1.5)
.setTotalTimeoutDuration(Duration.ofSeconds(300))
.build());
SpannerSettings spannerSettings = spannerSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) for additional support in setting
retries.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for SpannerSettings. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to batchCreateSessions.Returns the object with the settings used for calls to batchWrite.Returns the object with the settings used for calls to beginTransaction.Returns the object with the settings used for calls to commit.static final SpannerSettingscreate(SpannerStubSettings stub) Returns the object with the settings used for calls to createSession.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderUnaryCallSettings<DeleteSessionRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteSession.Returns the object with the settings used for calls to executeBatchDml.Returns the object with the settings used for calls to executeSql.Returns the object with the settings used for calls to executeStreamingSql.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getSession.Returns the object with the settings used for calls to listSessions.static SpannerSettings.BuilderReturns a new gRPC builder for this class.static SpannerSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static SpannerSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to partitionQuery.Returns the object with the settings used for calls to partitionRead.Returns the object with the settings used for calls to read.UnaryCallSettings<RollbackRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to rollback.Returns the object with the settings used for calls to streamingRead.Returns a builder containing all the values of this settings class.Methods inherited from class com.google.api.gax.rpc.ClientSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString
-
Constructor Details
-
SpannerSettings
- Throws:
IOException
-
-
Method Details
-
createSessionSettings
Returns the object with the settings used for calls to createSession. -
batchCreateSessionsSettings
public UnaryCallSettings<BatchCreateSessionsRequest,BatchCreateSessionsResponse> batchCreateSessionsSettings()Returns the object with the settings used for calls to batchCreateSessions. -
getSessionSettings
Returns the object with the settings used for calls to getSession. -
listSessionsSettings
public PagedCallSettings<ListSessionsRequest,ListSessionsResponse, listSessionsSettings()SpannerClient.ListSessionsPagedResponse> Returns the object with the settings used for calls to listSessions. -
deleteSessionSettings
Returns the object with the settings used for calls to deleteSession. -
executeSqlSettings
Returns the object with the settings used for calls to executeSql. -
executeStreamingSqlSettings
public ServerStreamingCallSettings<ExecuteSqlRequest,PartialResultSet> executeStreamingSqlSettings()Returns the object with the settings used for calls to executeStreamingSql. -
executeBatchDmlSettings
Returns the object with the settings used for calls to executeBatchDml. -
readSettings
Returns the object with the settings used for calls to read. -
streamingReadSettings
Returns the object with the settings used for calls to streamingRead. -
beginTransactionSettings
Returns the object with the settings used for calls to beginTransaction. -
commitSettings
Returns the object with the settings used for calls to commit. -
rollbackSettings
Returns the object with the settings used for calls to rollback. -
partitionQuerySettings
Returns the object with the settings used for calls to partitionQuery. -
partitionReadSettings
Returns the object with the settings used for calls to partitionRead. -
batchWriteSettings
Returns the object with the settings used for calls to batchWrite. -
create
- Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<SpannerSettings>
-