public sealed class FirestoreDbBuilder : ClientBuilderBase<FirestoreDb>Reference documentation and code samples for the Firestore API class FirestoreDbBuilder.
Builder class for FirestoreDb, providing simple configuration of credentials, endpoint, project ID etc.
Namespace
Google.Cloud.FirestoreAssembly
Google.Cloud.Firestore.dll
Constructors
FirestoreDbBuilder()
public FirestoreDbBuilder()Creates a new builder with default settings.
Properties
ConverterRegistry
public ConverterRegistry ConverterRegistry { get; set; }A registry for custom converters. May be null.
| Property Value | |
|---|---|
| Type | Description |
ConverterRegistry | |
EmulatorDetection
public EmulatorDetection EmulatorDetection { get; set; }Specifies how the builder responds to the presence of the FIRESTORE_EMULATOR_HOST emulator environment variable.
| Property Value | |
|---|---|
| Type | Description |
EmulatorDetection | |
This property defaults to None, meaning that the environment variable is ignored.
ProjectId
public string ProjectId { get; set; }The ID of the Google Cloud project that contains the database. May be null, in which case the project will be automatically detected if possible.
| Property Value | |
|---|---|
| Type | Description |
string | |
Settings
public FirestoreSettings Settings { get; set; }The settings to use for RPCs, or null for the default settings.
| Property Value | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
Actionstring | |
Methods
Build()
public override FirestoreDb Build()| Returns | |
|---|---|
| Type | Description |
FirestoreDb | |
BuildAsync(CancellationToken)
public override Task<FirestoreDb> BuildAsync(CancellationToken cancellationToken = default)| Parameter | |
|---|---|
| Name | Description |
cancellationToken | CancellationToken |
| Returns | |
|---|---|
| Type | Description |
TaskFirestoreDb | |
GetChannelPool()
protected override ChannelPool GetChannelPool()| Returns | |
|---|---|
| Type | Description |
ChannelPool | |