Class SpannerClientBuilder (3.5.0) 

public sealed class SpannerClientBuilder : ClientBuilderBase<SpannerClient>

Builder class for SpannerClient to provide simple configuration of credentials, endpoint etc.

Inheritance

Object > Google.Api.Gax.Grpc.ClientBuilderBase<SpannerClient> > SpannerClientBuilder

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Properties

DefaultGrpcAdapter

protected override GrpcAdapter DefaultGrpcAdapter { get; }

Returns the default Google.Api.Gax.Grpc.GrpcAdapterto use if not otherwise specified.

Property Value
TypeDescription
Google.Api.Gax.Grpc.GrpcAdapter
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Spanner.V1.SpannerClient>.DefaultGrpcAdapter

EmulatorDetection

public EmulatorDetection EmulatorDetection { get; set; }

Specifies how the builder responds to the presence of emulator environment variables.

Property Value
TypeDescription
Google.Api.Gax.EmulatorDetection
Remarks

This property defaults to Google.Api.Gax.EmulatorDetection.None, meaning that environment variables are ignored.

EnvironmentVariableProvider

public Func<string, string> EnvironmentVariableProvider { get; set; }

An environment variable provider function (variable -> value) that is used during emulator environment detection. This is provided for testability, so that clients are able to test how they would connect based on emulator environment variables. This is not expected to be used in production code. The default value of null indicates "use the regular process environment variables".

Property Value
TypeDescription
Func<String, String>

Settings

public SpannerSettings Settings { get; set; }

The settings to use for RPCs, or null for the default settings.

Property Value
TypeDescription
SpannerSettings

Methods

Build()

public override SpannerClient Build()

Builds the resulting client.

Returns
TypeDescription
SpannerClient
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Spanner.V1.SpannerClient>.Build()

BuildAsync(CancellationToken)

public override Task<SpannerClient> BuildAsync(CancellationToken cancellationToken = default(CancellationToken))

Builds the resulting client asynchronously.

Parameter
NameDescription
cancellationTokenCancellationToken
Returns
TypeDescription
Task<SpannerClient>
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Spanner.V1.SpannerClient>.BuildAsync(System.Threading.CancellationToken)

GetChannelPool()

protected override ChannelPool GetChannelPool()

Returns the channel pool to use when no other options are specified.

Returns
TypeDescription
Google.Api.Gax.Grpc.ChannelPool
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Spanner.V1.SpannerClient>.GetChannelPool()

GetDefaultEndpoint()

protected override string GetDefaultEndpoint()

Returns the endpoint for this builder type, used if no endpoint is otherwise specified.

Returns
TypeDescription
String
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Spanner.V1.SpannerClient>.GetDefaultEndpoint()

GetDefaultScopes()

protected override IReadOnlyList<string> GetDefaultScopes()

Returns the default scopes for this builder type, used if no scopes are otherwise specified.

Returns
TypeDescription
IReadOnlyList<String>
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Spanner.V1.SpannerClient>.GetDefaultScopes()

MaybeCreateEmulatorClientBuilder()

public SpannerClientBuilder MaybeCreateEmulatorClientBuilder()

May return a builder that will connect to the emulator under certain conditions.

Returns
TypeDescription
SpannerClientBuilder
Remarks

It returns null if the emulator should not be used, e.g. if EmulatorDetection is Google.Api.Gax.EmulatorDetection.EmulatorOrProduction but the environment variable isn't configured. Otherwise, returns a builder with the endpoint and credentials set appropriately for the emulator.