Firestore Admin v1 API - Class FirestoreAdminClientBuilder (3.11.0)

public sealed class FirestoreAdminClientBuilder : ClientBuilderBase<FirestoreAdminClient>

Reference documentation and code samples for the Firestore Admin v1 API class FirestoreAdminClientBuilder.

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

Inheritance

object > ClientBuilderBaseFirestoreAdminClient > FirestoreAdminClientBuilder

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

FirestoreAdminClientBuilder()

public FirestoreAdminClientBuilder()

Creates a new builder with default settings.

Properties

Settings

public FirestoreAdminSettings Settings { get; set; }

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

Property Value
Type Description
FirestoreAdminSettings

Methods

Build()

public override FirestoreAdminClient Build()

Builds the resulting client.

Returns
Type Description
FirestoreAdminClient
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.Build()

BuildAsync(CancellationToken)

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

Builds the resulting client asynchronously.

Parameter
Name Description
cancellationToken CancellationToken
Returns
Type Description
TaskFirestoreAdminClient
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.BuildAsync(System.Threading.CancellationToken)

GetChannelPool()

protected override ChannelPool GetChannelPool()

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

Returns
Type Description
ChannelPool
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.GetChannelPool()