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

Inherited Members

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

ClientBuilderBase<FirestoreAdminClient>.CopySettingsForEmulator(ClientBuilderBase<FirestoreAdminClient>)

ClientBuilderBase<FirestoreAdminClient>.Validate()

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

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

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

ClientBuilderBase<FirestoreAdminClient>.CreateCallInvoker()

ClientBuilderBase<FirestoreAdminClient>.CreateCallInvokerAsync(CancellationToken)

ClientBuilderBase<FirestoreAdminClient>.GetChannelCredentials()

ClientBuilderBase<FirestoreAdminClient>.GetChannelCredentialsAsync(CancellationToken)

ClientBuilderBase<FirestoreAdminClient>.GetChannelOptions()

ClientBuilderBase<FirestoreAdminClient>.Endpoint

ClientBuilderBase<FirestoreAdminClient>.Scopes

ClientBuilderBase<FirestoreAdminClient>.ChannelCredentials

ClientBuilderBase<FirestoreAdminClient>.CredentialsPath

ClientBuilderBase<FirestoreAdminClient>.JsonCredentials

ClientBuilderBase<FirestoreAdminClient>.TokenAccessMethod

ClientBuilderBase<FirestoreAdminClient>.CallInvoker

ClientBuilderBase<FirestoreAdminClient>.UserAgent

ClientBuilderBase<FirestoreAdminClient>.GrpcAdapter

ClientBuilderBase<FirestoreAdminClient>.EmulatorDetection

ClientBuilderBase<FirestoreAdminClient>.QuotaProject

ClientBuilderBase<FirestoreAdminClient>.GrpcChannelOptions

ClientBuilderBase<FirestoreAdminClient>.CanUseChannelPool

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

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

Methods

Build()

public override FirestoreAdminClient Build()

Builds the resulting client.

Returns
Type	Description
`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
Name	Description
`cancellationToken`	`CancellationToken`

Returns
Type	Description
`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
Type	Description
`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
Type	Description
`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
Type	Description
`IReadOnlyList<String>`

Overrides

Google.Api.Gax.Grpc.ClientBuilderBase<Google.Cloud.Firestore.Admin.V1.FirestoreAdminClient>.GetDefaultScopes()