Class FirestoreAdminClientBuilder (2.2.0)

public sealed class FirestoreAdminClientBuilder : ClientBuilderBase<FirestoreAdminClient>

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

Inheritance

Object > ClientBuilderBase<FirestoreAdminClient> > FirestoreAdminClientBuilder

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Properties

DefaultGrpcAdapter

protected override GrpcAdapter DefaultGrpcAdapter { get; }

Returns the default GrpcAdapterto use if not otherwise specified.

Property Value
TypeDescription
GrpcAdapter
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.DefaultGrpcAdapter

Settings

public FirestoreAdminSettings Settings { get; set; }

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

Property Value
TypeDescription
FirestoreAdminSettings

Methods

Build()

public override FirestoreAdminClient Build()

Builds the resulting client.

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

BuildAsync(CancellationToken)

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

Builds the resulting client asynchronously.

Parameter
NameDescription
cancellationTokenCancellationToken
Returns
TypeDescription
Task<FirestoreAdminClient>
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
TypeDescription
ChannelPool
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.GetChannelPool()

GetDefaultEndpoint()

protected override string GetDefaultEndpoint()

Returns the endpoint for this builder type, used if no endpoint is otherwise specified.

Returns
TypeDescription
String
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.GetDefaultEndpoint()

GetDefaultScopes()

protected override IReadOnlyList<string> GetDefaultScopes()

Returns the default scopes for this builder type, used if no scopes are otherwise specified.

Returns
TypeDescription
IReadOnlyList<String>
Overrides
Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.GetDefaultScopes()