Google Bigtable v2 API - Class BigtableClientBuilder (3.15.0)

public sealed class BigtableClientBuilder : ClientBuilderBase<BigtableClient>

Reference documentation and code samples for the Google Bigtable v2 API class BigtableClientBuilder.

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

Inheritance

object > ClientBuilderBaseBigtableClient > BigtableClientBuilder

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

BigtableClientBuilder()

public BigtableClientBuilder()

Creates a new builder with default settings.

Properties

EmulatorDetection

public EmulatorDetection EmulatorDetection { get; set; }

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

Property Value
Type Description
EmulatorDetection
Remarks

This property defaults to None, meaning that environment variables are ignored.

Settings

public BigtableServiceApiSettings Settings { get; set; }

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

Property Value
Type Description
BigtableServiceApiSettings

Methods

Build()

public override BigtableClient Build()

Builds the resulting client.

Returns
Type Description
BigtableClient
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Bigtable.V2.BigtableClient>.Build()

BuildAsync(CancellationToken)

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

Builds the resulting client asynchronously.

Parameter
Name Description
cancellationToken CancellationToken
Returns
Type Description
TaskBigtableClient
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Bigtable.V2.BigtableClient>.BuildAsync(System.Threading.CancellationToken)

GetChannelPool()

protected override ChannelPool GetChannelPool()

Returns the channel pool to use when no other options are specified. This method is not called unless CanUseChannelPool returns true, so if a channel pool is unavailable, override that property to return false and throw an exception from this method.

Returns
Type Description
ChannelPool
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Bigtable.V2.BigtableClient>.GetChannelPool()