Package com.google.cloud.spanner.v1

Class SpannerSettings

java.lang.Object
com.google.api.gax.rpc.ClientSettings<SpannerSettings>
com.google.cloud.spanner.v1.SpannerSettings
@Generated("by gapic-generator-java") public class SpannerSettings extends com.google.api.gax.rpc.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: 


 // 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()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SpannerSettings spannerSettings = spannerSettingsBuilder.build();

  • Constructor Details

  • Method Details

    • createSessionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CreateSessionRequest,Session> createSessionSettings()
      Returns the object with the settings used for calls to createSession.

    • batchCreateSessionsSettings

      public com.google.api.gax.rpc.UnaryCallSettings<BatchCreateSessionsRequest,BatchCreateSessionsResponse> batchCreateSessionsSettings()
      Returns the object with the settings used for calls to batchCreateSessions.

    • getSessionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<GetSessionRequest,Session> getSessionSettings()
      Returns the object with the settings used for calls to getSession.

    • listSessionsSettings

      public com.google.api.gax.rpc.PagedCallSettings<ListSessionsRequest,ListSessionsResponse,SpannerClient.ListSessionsPagedResponse> listSessionsSettings()
      Returns the object with the settings used for calls to listSessions.

    • deleteSessionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<DeleteSessionRequest,com.google.protobuf.Empty> deleteSessionSettings()
      Returns the object with the settings used for calls to deleteSession.

    • executeSqlSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ExecuteSqlRequest,ResultSet> executeSqlSettings()
      Returns the object with the settings used for calls to executeSql.

    • executeStreamingSqlSettings

      public com.google.api.gax.rpc.ServerStreamingCallSettings<ExecuteSqlRequest,PartialResultSet> executeStreamingSqlSettings()
      Returns the object with the settings used for calls to executeStreamingSql.

    • executeBatchDmlSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse> executeBatchDmlSettings()
      Returns the object with the settings used for calls to executeBatchDml.

    • readSettings

      public com.google.api.gax.rpc.UnaryCallSettings<ReadRequest,ResultSet> readSettings()
      Returns the object with the settings used for calls to read.

    • streamingReadSettings

      public com.google.api.gax.rpc.ServerStreamingCallSettings<ReadRequest,PartialResultSet> streamingReadSettings()
      Returns the object with the settings used for calls to streamingRead.

    • beginTransactionSettings

      public com.google.api.gax.rpc.UnaryCallSettings<BeginTransactionRequest,Transaction> beginTransactionSettings()
      Returns the object with the settings used for calls to beginTransaction.

    • commitSettings

      public com.google.api.gax.rpc.UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()
      Returns the object with the settings used for calls to commit.

    • rollbackSettings

      public com.google.api.gax.rpc.UnaryCallSettings<RollbackRequest,com.google.protobuf.Empty> rollbackSettings()
      Returns the object with the settings used for calls to rollback.

    • partitionQuerySettings

      public com.google.api.gax.rpc.UnaryCallSettings<PartitionQueryRequest,PartitionResponse> partitionQuerySettings()
      Returns the object with the settings used for calls to partitionQuery.

    • partitionReadSettings

      public com.google.api.gax.rpc.UnaryCallSettings<PartitionReadRequest,PartitionResponse> partitionReadSettings()
      Returns the object with the settings used for calls to partitionRead.

    • batchWriteSettings

      public com.google.api.gax.rpc.ServerStreamingCallSettings<BatchWriteRequest,BatchWriteResponse> batchWriteSettings()
      Returns the object with the settings used for calls to batchWrite.

    • create

      public static final SpannerSettings create(SpannerStubSettings stub) throws IOException
      Throws:
      IOException

    • defaultExecutorProviderBuilder

      public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()
      Returns a builder for the default ExecutorProvider for this service.

    • getDefaultEndpoint

      public static String getDefaultEndpoint()
      Returns the default service endpoint.

    • getDefaultServiceScopes

      public static List<String> getDefaultServiceScopes()
      Returns the default service scopes.

    • defaultCredentialsProviderBuilder

      public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()
      Returns a builder for the default credentials for this service.

    • defaultGrpcTransportProviderBuilder

      public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()
      Returns a builder for the default gRPC ChannelProvider for this service.

    • defaultHttpJsonTransportProviderBuilder

      @BetaApi public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()
      Returns a builder for the default REST ChannelProvider for this service.

    • defaultTransportChannelProvider

      public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

    • defaultApiClientHeaderProviderBuilder

      public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

    • newBuilder

      public static SpannerSettings.Builder newBuilder()
      Returns a new gRPC builder for this class.

    • newHttpJsonBuilder

      @BetaApi public static SpannerSettings.Builder newHttpJsonBuilder()
      Returns a new REST builder for this class.

    • newBuilder

      public static SpannerSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)
      Returns a new builder for this class.

    • toBuilder

      public SpannerSettings.Builder toBuilder()
      Returns a builder containing all the values of this settings class.
      Specified by:
      toBuilder in class com.google.api.gax.rpc.ClientSettings<SpannerSettings>