public sealed class FirestoreClientBuilder : ClientBuilderBase<FirestoreClient>Builder class for FirestoreClient to provide simple configuration of credentials, endpoint etc.
Namespace
Google.Cloud.Firestore.V1Assembly
Google.Cloud.Firestore.V1.dll
Constructors
FirestoreClientBuilder()
public FirestoreClientBuilder()Creates a new builder with default settings.
Properties
DefaultGrpcAdapter
protected override GrpcAdapter DefaultGrpcAdapter { get; }Returns the default GrpcAdapterto use if not otherwise specified.
| Property Value | |
|---|---|
| Type | Description |
GrpcAdapter | |
Settings
public FirestoreSettings Settings { get; set; }The settings to use for RPCs, or null for the default settings.
| Property Value | |
|---|---|
| Type | Description |
FirestoreSettings | |
Methods
Build()
public override FirestoreClient Build()Builds the resulting client.
| Returns | |
|---|---|
| Type | Description |
FirestoreClient | |
BuildAsync(CancellationToken)
public override Task<FirestoreClient> BuildAsync(CancellationToken cancellationToken = default(CancellationToken))Builds the resulting client asynchronously.
| Parameter | |
|---|---|
| Name | Description |
cancellationToken | CancellationToken |
| Returns | |
|---|---|
| Type | Description |
Task<FirestoreClient> | |
FromOtherBuilder<T>(ClientBuilderBase<T>)
public static FirestoreClientBuilder FromOtherBuilder<T>(ClientBuilderBase<T> builder)Creates a FirestoreClientBuilder by copying common settings from another builder. This method is intended for use in Google.Cloud.Firestore with FirestoreDbBuilder. It will work in other scenarios, but is usually not necessary.
| Parameter | |
|---|---|
| Name | Description |
builder | ClientBuilderBase<T>The builder to copy settings from. Must not be null. |
| Returns | |
|---|---|
| Type | Description |
FirestoreClientBuilder | A FirestoreClientBuilder with common settings from |
| Type Parameter | |
|---|---|
| Name | Description |
T | The client type of the builder. |
GetChannelPool()
protected override ChannelPool GetChannelPool()Returns the channel pool to use when no other options are specified.
| Returns | |
|---|---|
| Type | Description |
ChannelPool | |
GetDefaultEndpoint()
protected override string GetDefaultEndpoint()Returns the endpoint for this builder type, used if no endpoint is otherwise specified.
| Returns | |
|---|---|
| Type | Description |
String | |
GetDefaultScopes()
protected override IReadOnlyList<string> GetDefaultScopes()Returns the default scopes for this builder type, used if no scopes are otherwise specified.
| Returns | |
|---|---|
| Type | Description |
IReadOnlyList<String> | |