Class FirestoreDbBuilder

public sealed class FirestoreDbBuilder : ClientBuilderBase<FirestoreDb>

Builder class for FirestoreDb, providing simple configuration of credentials, endpoint, project ID etc.

Inheritance

Object > ClientBuilderBase<FirestoreDb> > FirestoreDbBuilder

Namespace

Google.Cloud.Firestore

Assembly

Google.Cloud.Firestore.dll

Properties

ConverterRegistry

public ConverterRegistry ConverterRegistry { get; set; }

A registry for custom converters. May be null.

Property Value
TypeDescription
ConverterRegistry

DefaultGrpcAdapter

protected override GrpcAdapter DefaultGrpcAdapter { get; }
Property Value
TypeDescription
GrpcAdapter
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.DefaultGrpcAdapter

EmulatorDetection

public EmulatorDetection EmulatorDetection { get; set; }

Specifies how the builder responds to the presence of the FIRESTORE_EMULATOR_HOST emulator environment variable.

Property Value
TypeDescription
EmulatorDetection
Remarks

This property defaults to None, meaning that the environment variable is ignored.

ProjectId

public string ProjectId { get; set; }

The ID of the Google Cloud Platform project that contains the database. May be null, in which case the project will be automatically detected if possible.

Property Value
TypeDescription
String

Settings

public FirestoreSettings Settings { get; set; }

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

Property Value
TypeDescription
Google.Cloud.Firestore.V1.FirestoreSettings

WarningLogger

public Action<string> WarningLogger { get; set; }

Action to receive warning messages. May be null, in which case warnings will be ignored.

Property Value
TypeDescription
Action<String>

Methods

Build()

public override FirestoreDb Build()
Returns
TypeDescription
FirestoreDb
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.Build()

BuildAsync(CancellationToken)

public override Task<FirestoreDb> BuildAsync(CancellationToken cancellationToken = default(CancellationToken))
Parameter
NameDescription
cancellationTokenCancellationToken
Returns
TypeDescription
Task<FirestoreDb>
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.BuildAsync(System.Threading.CancellationToken)

GetChannelPool()

protected override ChannelPool GetChannelPool()
Returns
TypeDescription
ChannelPool
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.GetChannelPool()

GetDefaultEndpoint()

protected override string GetDefaultEndpoint()
Returns
TypeDescription
String
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.GetDefaultEndpoint()

GetDefaultScopes()

protected override IReadOnlyList<string> GetDefaultScopes()
Returns
TypeDescription
IReadOnlyList<String>
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.GetDefaultScopes()