Google Bigtable v2 API - Class BigtableServiceApiClientBuilder (3.13.0)

public sealed class BigtableServiceApiClientBuilder : ClientBuilderBase<BigtableServiceApiClient>

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

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

Inheritance

object > ClientBuilderBaseBigtableServiceApiClient > BigtableServiceApiClientBuilder

Namespace

Google.Cloud.Bigtable.V2

Assembly

Google.Cloud.Bigtable.V2.dll

Constructors

BigtableServiceApiClientBuilder()

public BigtableServiceApiClientBuilder()

Creates a new builder with default settings.

Properties

CanUseChannelPool

protected override bool CanUseChannelPool { get; }

Returns whether or not a channel pool can be used if a channel is required. The default behavior is to return true if and only if no quota project, scopes, credentials or token access method have been specified and if UseJwtAccessWithScopes flag matches the flag in ChannelPool. Derived classes should override this property if there are other reasons why the channel pool should not be used.

Property Value
Type Description
bool
Overrides

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 BigtableServiceApiClient Build()

Builds the resulting client.

Returns
Type Description
BigtableServiceApiClient
Overrides

BuildAsync(CancellationToken)

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

Builds the resulting client asynchronously.

Parameter
Name Description
cancellationToken CancellationToken
Returns
Type Description
TaskBigtableServiceApiClient
Overrides

CreateCallInvoker()

protected override CallInvoker CreateCallInvoker()

Creates a call invoker synchronously. Override this method in a concrete builder type if more call invoker mechanisms are supported. This implementation calls GetChannelCredentials() if no call invoker is specified.

Returns
Type Description
CallInvoker
Overrides

CreateCallInvokerAsync(CancellationToken)

protected override Task<CallInvoker> CreateCallInvokerAsync(CancellationToken cancellationToken)

Creates a call invoker asynchronously. Override this method in a concrete builder type if more call invoker mechanisms are supported. This implementation calls GetChannelCredentialsAsync(CancellationToken) if no call invoker is specified.

Parameter
Name Description
cancellationToken CancellationToken
Returns
Type Description
TaskCallInvoker
Overrides

CreateGcpCallInvoker()

public GcpCallInvoker CreateGcpCallInvoker()

Creates a GcpCallInvoker which is a call invoker that can distribute calls across different underlying channels based on request properties.

Returns
Type Description
GcpCallInvoker

CreateGcpCallInvokerAsync(CancellationToken)

public Task<GcpCallInvoker> CreateGcpCallInvokerAsync(CancellationToken cancellationToken)

Creates a GcpCallInvoker which is a call invoker that can distribute calls across different underlying channels based on request properties.

Parameter
Name Description
cancellationToken CancellationToken
Returns
Type Description
TaskGcpCallInvoker

GetChannelOptions()

protected override GrpcChannelOptions GetChannelOptions()

Returns the options to use when creating a channel, taking GrpcChannelOptions into account.

Returns
Type Description
GrpcChannelOptions

The options to use when creating a channel.
Overrides

GetChannelPool()

protected override ChannelPool GetChannelPool()

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

Returns
Type Description
ChannelPool
Overrides