Google Cloud Spanner v1 API - Class SpannerSettings (5.0.0-beta02)

public sealed class SpannerSettings : ServiceSettingsBase

Reference documentation and code samples for the Google Cloud Spanner v1 API class SpannerSettings.

Settings for SpannerClient instances.

Inheritance

object > ServiceSettingsBase > SpannerSettings

Inherited Members

ServiceSettingsBase.VersionHeaderBuilder

ServiceSettingsBase.CallSettings

ServiceSettingsBase.Clock

ServiceSettingsBase.Scheduler

ServiceSettingsBase.Interceptor

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

SpannerSettings()

public SpannerSettings()

Constructs a new SpannerSettings object with default settings.

Properties

BatchCreateSessionsSettings

public CallSettings BatchCreateSessionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.BatchCreateSessions and SpannerClient.BatchCreateSessionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 60 seconds.

BatchWriteSettings

public CallSettings BatchWriteSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.BatchWrite and SpannerClient.BatchWriteAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 3600 seconds.

BeginTransactionSettings

public CallSettings BeginTransactionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.BeginTransaction and SpannerClient.BeginTransactionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

CommitSettings

public CallSettings CommitSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.Commit and SpannerClient.CommitAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 3600 seconds.

CreateSessionSettings

public CallSettings CreateSessionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.CreateSession and SpannerClient.CreateSessionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

DeleteSessionSettings

public CallSettings DeleteSessionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.DeleteSession and SpannerClient.DeleteSessionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

ExecuteBatchDmlSettings

public CallSettings ExecuteBatchDmlSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.ExecuteBatchDml and SpannerClient.ExecuteBatchDmlAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

ExecuteSqlSettings

public CallSettings ExecuteSqlSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.ExecuteSql and SpannerClient.ExecuteSqlAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

ExecuteStreamingSqlSettings

public CallSettings ExecuteStreamingSqlSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.ExecuteStreamingSql and SpannerClient.ExecuteStreamingSqlAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 3600 seconds.

GetSessionSettings

public CallSettings GetSessionSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.GetSession and SpannerClient.GetSessionAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

ListSessionsSettings

public CallSettings ListSessionsSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.ListSessions and SpannerClient.ListSessionsAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 3600 seconds.

Logger

public Logger Logger { get; set; }

The logger to use for operations involving this client. This property is never null.

Property Value
Type	Description
`Logger`

PartitionQuerySettings

public CallSettings PartitionQuerySettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.PartitionQuery and SpannerClient.PartitionQueryAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

PartitionReadSettings

public CallSettings PartitionReadSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.PartitionRead and SpannerClient.PartitionReadAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

ReadSettings

public CallSettings ReadSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.Read and SpannerClient.ReadAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

RollbackSettings

public CallSettings RollbackSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.Rollback and SpannerClient.RollbackAsync.

Property Value
Type	Description
`CallSettings`

Remarks

Initial retry delay: 250 milliseconds.
Retry delay multiplier: 1.3
Retry maximum delay: 32000 milliseconds.
Maximum attempts: Unlimited
Retriable status codes: Unavailable.
Timeout: 30 seconds.

StreamingReadSettings

public CallSettings StreamingReadSettings { get; set; }

CallSettings for synchronous and asynchronous calls to SpannerClient.StreamingRead and SpannerClient.StreamingReadAsync.

Property Value
Type	Description
`CallSettings`

Remarks

This call will not be retried.
Timeout: 3600 seconds.

Methods

Clone()

public SpannerSettings Clone()

Creates a deep clone of this object, with all the same property values.

Returns
Type	Description
`SpannerSettings`	A deep clone of this SpannerSettings object.

GetDefault()

public static SpannerSettings GetDefault()

Get a new instance of the default SpannerSettings.

Returns
Type	Description
`SpannerSettings`	A new instance of the default SpannerSettings.