Class FirestoreDbBuilder (2.4.0)

public sealed class FirestoreDbBuilder : ClientBuilderBase<FirestoreDb>

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

Inheritance

Object > ClientBuilderBase<FirestoreDb> > FirestoreDbBuilder

Inherited Members

ClientBuilderBase<FirestoreDb>.CopyCommonSettings<TOther>(ClientBuilderBase<TOther>)

ClientBuilderBase<FirestoreDb>.CopySettingsForEmulator(ClientBuilderBase<FirestoreDb>)

ClientBuilderBase<FirestoreDb>.Validate()

ClientBuilderBase<FirestoreDb>.GetEmulatorEnvironment(IEnumerable<String>, IEnumerable<String>, Func<String, String>)

ClientBuilderBase<FirestoreDb>.ValidateAtMostOneNotNull(String, Object[])

ClientBuilderBase<FirestoreDb>.ValidateOptionExcludesOthers(String, Object, Object[])

ClientBuilderBase<FirestoreDb>.CreateCallInvoker()

ClientBuilderBase<FirestoreDb>.CreateCallInvokerAsync(CancellationToken)

ClientBuilderBase<FirestoreDb>.GetChannelCredentials()

ClientBuilderBase<FirestoreDb>.GetChannelCredentialsAsync(CancellationToken)

ClientBuilderBase<FirestoreDb>.GetChannelOptions()

ClientBuilderBase<FirestoreDb>.Endpoint

ClientBuilderBase<FirestoreDb>.Scopes

ClientBuilderBase<FirestoreDb>.ChannelCredentials

ClientBuilderBase<FirestoreDb>.CredentialsPath

ClientBuilderBase<FirestoreDb>.JsonCredentials

ClientBuilderBase<FirestoreDb>.TokenAccessMethod

ClientBuilderBase<FirestoreDb>.CallInvoker

ClientBuilderBase<FirestoreDb>.UserAgent

ClientBuilderBase<FirestoreDb>.GrpcAdapter

ClientBuilderBase<FirestoreDb>.QuotaProject

ClientBuilderBase<FirestoreDb>.GrpcChannelOptions

ClientBuilderBase<FirestoreDb>.CanUseChannelPool

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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
Type	Description
`ConverterRegistry`

DefaultGrpcAdapter

protected override GrpcAdapter DefaultGrpcAdapter { get; }

Property Value
Type	Description
`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
Type	Description
`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
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
`Action<String>`

Methods

Build()

public override FirestoreDb Build()

Returns
Type	Description
`FirestoreDb`

Overrides

Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.Build()

BuildAsync(CancellationToken)

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

Parameter
Name	Description
`cancellationToken`	`CancellationToken`

Returns
Type	Description
`Task<FirestoreDb>`

Overrides

Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.BuildAsync(System.Threading.CancellationToken)

GetChannelPool()

protected override ChannelPool GetChannelPool()

Returns
Type	Description
`ChannelPool`

Overrides

Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.GetChannelPool()

GetDefaultEndpoint()

protected override string GetDefaultEndpoint()

Returns
Type	Description
`String`

Overrides

Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.GetDefaultEndpoint()

GetDefaultScopes()

protected override IReadOnlyList<string> GetDefaultScopes()

Returns
Type	Description
`IReadOnlyList<String>`

Overrides

Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.FirestoreDb>.GetDefaultScopes()