com.google.cloud.spanner.v1.stub

Class SpannerStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<SpannerStubSettings>

com.google.cloud.spanner.v1.stub.SpannerStubSettings

@Generated(value="by gapic-generator-java")
public class SpannerStubSettings
extends StubSettings<SpannerStubSettings>

Settings class to configure an instance of SpannerStub.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 SpannerStubSettings.Builder spannerSettingsBuilder = SpannerStubSettings.newBuilder();
 spannerSettingsBuilder
     .createSessionSettings()
     .setRetrySettings(
         spannerSettingsBuilder
             .createSessionSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 SpannerStubSettings spannerSettings = spannerSettingsBuilder.build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SpannerStubSettings.Builder Builder for SpannerStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SpannerStubSettings(SpannerStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
UnaryCallSettings<BatchCreateSessionsRequest,BatchCreateSessionsResponse>	batchCreateSessionsSettings() Returns the object with the settings used for calls to batchCreateSessions.
UnaryCallSettings<BeginTransactionRequest,Transaction>	beginTransactionSettings() Returns the object with the settings used for calls to beginTransaction.
UnaryCallSettings<CommitRequest,CommitResponse>	commitSettings() Returns the object with the settings used for calls to commit.
UnaryCallSettings<CreateSessionRequest,Session>	createSessionSettings() Returns the object with the settings used for calls to createSession.
SpannerStub	createStub()
static ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static TransportChannelProvider	defaultTransportChannelProvider()
UnaryCallSettings<DeleteSessionRequest,Empty>	deleteSessionSettings() Returns the object with the settings used for calls to deleteSession.
UnaryCallSettings<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse>	executeBatchDmlSettings() Returns the object with the settings used for calls to executeBatchDml.
UnaryCallSettings<ExecuteSqlRequest,ResultSet>	executeSqlSettings() Returns the object with the settings used for calls to executeSql.
ServerStreamingCallSettings<ExecuteSqlRequest,PartialResultSet>	executeStreamingSqlSettings() Returns the object with the settings used for calls to executeStreamingSql.
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
UnaryCallSettings<GetSessionRequest,Session>	getSessionSettings() Returns the object with the settings used for calls to getSession.
PagedCallSettings<ListSessionsRequest,ListSessionsResponse,SpannerClient.ListSessionsPagedResponse>	listSessionsSettings() Returns the object with the settings used for calls to listSessions.
static SpannerStubSettings.Builder	newBuilder() Returns a new builder for this class.
static SpannerStubSettings.Builder	newBuilder(ClientContext clientContext) Returns a new builder for this class.
UnaryCallSettings<PartitionQueryRequest,PartitionResponse>	partitionQuerySettings() Returns the object with the settings used for calls to partitionQuery.
UnaryCallSettings<PartitionReadRequest,PartitionResponse>	partitionReadSettings() Returns the object with the settings used for calls to partitionRead.
UnaryCallSettings<ReadRequest,ResultSet>	readSettings() Returns the object with the settings used for calls to read.
UnaryCallSettings<RollbackRequest,Empty>	rollbackSettings() Returns the object with the settings used for calls to rollback.
ServerStreamingCallSettings<ReadRequest,PartialResultSet>	streamingReadSettings() Returns the object with the settings used for calls to streamingRead.
SpannerStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

SpannerStubSettings

protected SpannerStubSettings(SpannerStubSettings.Builder settingsBuilder)
                       throws IOException

Throws:

IOException

Method Detail

createSessionSettings

public UnaryCallSettings<CreateSessionRequest,Session> 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

public UnaryCallSettings<GetSessionRequest,Session> getSessionSettings()

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

listSessionsSettings

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

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

deleteSessionSettings

public UnaryCallSettings<DeleteSessionRequest,Empty> deleteSessionSettings()

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

executeSqlSettings

public UnaryCallSettings<ExecuteSqlRequest,ResultSet> 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

public UnaryCallSettings<ExecuteBatchDmlRequest,ExecuteBatchDmlResponse> executeBatchDmlSettings()

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

readSettings

public UnaryCallSettings<ReadRequest,ResultSet> readSettings()

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

streamingReadSettings

public ServerStreamingCallSettings<ReadRequest,PartialResultSet> streamingReadSettings()

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

beginTransactionSettings

public UnaryCallSettings<BeginTransactionRequest,Transaction> beginTransactionSettings()

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

commitSettings

public UnaryCallSettings<CommitRequest,CommitResponse> commitSettings()

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

rollbackSettings

public UnaryCallSettings<RollbackRequest,Empty> rollbackSettings()

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

partitionQuerySettings

public UnaryCallSettings<PartitionQueryRequest,PartitionResponse> partitionQuerySettings()

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

partitionReadSettings

public UnaryCallSettings<PartitionReadRequest,PartitionResponse> partitionReadSettings()

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

createStub

@BetaApi(value="A restructuring of stub classes is planned, so this may break in the future")
public SpannerStub createStub()
                                                                                                                     throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

@BetaApi(value="The surface for customizing headers is not stable yet and may change in the future.")
public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static SpannerStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static SpannerStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public SpannerStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class StubSettings<SpannerStubSettings>