Class FirestoreAdminClientImpl (2.2.0)

public sealed class FirestoreAdminClientImpl : FirestoreAdminClient

FirestoreAdmin client wrapper implementation, for convenient use.

Inheritance

Object > FirestoreAdminClient > FirestoreAdminClientImpl

Inherited Members

FirestoreAdminClient.DefaultEndpoint

FirestoreAdminClient.DefaultScopes

FirestoreAdminClient.CreateAsync(CancellationToken)

FirestoreAdminClient.Create()

FirestoreAdminClient.ShutdownDefaultChannelsAsync()

FirestoreAdminClient.CreateIndexAsync(CreateIndexRequest, CancellationToken)

FirestoreAdminClient.PollOnceCreateIndex(String, CallSettings)

FirestoreAdminClient.PollOnceCreateIndexAsync(String, CallSettings)

FirestoreAdminClient.CreateIndex(String, Index, CallSettings)

FirestoreAdminClient.CreateIndexAsync(String, Index, CallSettings)

FirestoreAdminClient.CreateIndexAsync(String, Index, CancellationToken)

FirestoreAdminClient.CreateIndex(CollectionGroupName, Index, CallSettings)

FirestoreAdminClient.CreateIndexAsync(CollectionGroupName, Index, CallSettings)

FirestoreAdminClient.CreateIndexAsync(CollectionGroupName, Index, CancellationToken)

FirestoreAdminClient.ListIndexes(String, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.ListIndexesAsync(String, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.ListIndexes(CollectionGroupName, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.ListIndexesAsync(CollectionGroupName, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.GetIndexAsync(GetIndexRequest, CancellationToken)

FirestoreAdminClient.GetIndex(String, CallSettings)

FirestoreAdminClient.GetIndexAsync(String, CallSettings)

FirestoreAdminClient.GetIndexAsync(String, CancellationToken)

FirestoreAdminClient.GetIndex(IndexName, CallSettings)

FirestoreAdminClient.GetIndexAsync(IndexName, CallSettings)

FirestoreAdminClient.GetIndexAsync(IndexName, CancellationToken)

FirestoreAdminClient.DeleteIndexAsync(DeleteIndexRequest, CancellationToken)

FirestoreAdminClient.DeleteIndex(String, CallSettings)

FirestoreAdminClient.DeleteIndexAsync(String, CallSettings)

FirestoreAdminClient.DeleteIndexAsync(String, CancellationToken)

FirestoreAdminClient.DeleteIndex(IndexName, CallSettings)

FirestoreAdminClient.DeleteIndexAsync(IndexName, CallSettings)

FirestoreAdminClient.DeleteIndexAsync(IndexName, CancellationToken)

FirestoreAdminClient.GetFieldAsync(GetFieldRequest, CancellationToken)

FirestoreAdminClient.GetField(String, CallSettings)

FirestoreAdminClient.GetFieldAsync(String, CallSettings)

FirestoreAdminClient.GetFieldAsync(String, CancellationToken)

FirestoreAdminClient.GetField(FieldName, CallSettings)

FirestoreAdminClient.GetFieldAsync(FieldName, CallSettings)

FirestoreAdminClient.GetFieldAsync(FieldName, CancellationToken)

FirestoreAdminClient.UpdateFieldAsync(UpdateFieldRequest, CancellationToken)

FirestoreAdminClient.PollOnceUpdateField(String, CallSettings)

FirestoreAdminClient.PollOnceUpdateFieldAsync(String, CallSettings)

FirestoreAdminClient.UpdateField(Field, CallSettings)

FirestoreAdminClient.UpdateFieldAsync(Field, CallSettings)

FirestoreAdminClient.UpdateFieldAsync(Field, CancellationToken)

FirestoreAdminClient.ListFields(String, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.ListFieldsAsync(String, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.ListFields(CollectionGroupName, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.ListFieldsAsync(CollectionGroupName, String, Nullable<Int32>, CallSettings)

FirestoreAdminClient.ExportDocumentsAsync(ExportDocumentsRequest, CancellationToken)

FirestoreAdminClient.PollOnceExportDocuments(String, CallSettings)

FirestoreAdminClient.PollOnceExportDocumentsAsync(String, CallSettings)

FirestoreAdminClient.ExportDocuments(String, CallSettings)

FirestoreAdminClient.ExportDocumentsAsync(String, CallSettings)

FirestoreAdminClient.ExportDocumentsAsync(String, CancellationToken)

FirestoreAdminClient.ExportDocuments(DatabaseName, CallSettings)

FirestoreAdminClient.ExportDocumentsAsync(DatabaseName, CallSettings)

FirestoreAdminClient.ExportDocumentsAsync(DatabaseName, CancellationToken)

FirestoreAdminClient.ImportDocumentsAsync(ImportDocumentsRequest, CancellationToken)

FirestoreAdminClient.PollOnceImportDocuments(String, CallSettings)

FirestoreAdminClient.PollOnceImportDocumentsAsync(String, CallSettings)

FirestoreAdminClient.ImportDocuments(String, CallSettings)

FirestoreAdminClient.ImportDocumentsAsync(String, CallSettings)

FirestoreAdminClient.ImportDocumentsAsync(String, CancellationToken)

FirestoreAdminClient.ImportDocuments(DatabaseName, CallSettings)

FirestoreAdminClient.ImportDocumentsAsync(DatabaseName, CallSettings)

FirestoreAdminClient.ImportDocumentsAsync(DatabaseName, CancellationToken)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Remarks

Operations are created by service FirestoreAdmin, but are accessed via service google.longrunning.Operations.

Constructors

FirestoreAdminClientImpl(FirestoreAdmin.FirestoreAdminClient, FirestoreAdminSettings)

public FirestoreAdminClientImpl(FirestoreAdmin.FirestoreAdminClient grpcClient, FirestoreAdminSettings settings)

Constructs a client wrapper for the FirestoreAdmin service, with the specified gRPC client and settings.

Parameters
Name	Description
`grpcClient`	`FirestoreAdmin.FirestoreAdminClient` The underlying gRPC client.
`settings`	`FirestoreAdminSettings` The base FirestoreAdminSettings used within this client.

Properties

CreateIndexOperationsClient

public override OperationsClient CreateIndexOperationsClient { get; }

The long-running operations client for CreateIndex.

Property Value
Type	Description
`OperationsClient`

Overrides

FirestoreAdminClient.CreateIndexOperationsClient

ExportDocumentsOperationsClient

public override OperationsClient ExportDocumentsOperationsClient { get; }

The long-running operations client for ExportDocuments.

Property Value
Type	Description
`OperationsClient`

Overrides

FirestoreAdminClient.ExportDocumentsOperationsClient

GrpcClient

public override FirestoreAdmin.FirestoreAdminClient GrpcClient { get; }

The underlying gRPC FirestoreAdmin client

Property Value
Type	Description
`FirestoreAdmin.FirestoreAdminClient`

Overrides

FirestoreAdminClient.GrpcClient

ImportDocumentsOperationsClient

public override OperationsClient ImportDocumentsOperationsClient { get; }

The long-running operations client for ImportDocuments.

Property Value
Type	Description
`OperationsClient`

Overrides

FirestoreAdminClient.ImportDocumentsOperationsClient

UpdateFieldOperationsClient

public override OperationsClient UpdateFieldOperationsClient { get; }

The long-running operations client for UpdateField.

Property Value
Type	Description
`OperationsClient`

Overrides

FirestoreAdminClient.UpdateFieldOperationsClient

Methods

CreateIndex(CreateIndexRequest, CallSettings)

public override Operation<Index, IndexOperationMetadata> CreateIndex(CreateIndexRequest request, CallSettings callSettings = null)

Creates a composite index. This returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the creation. The metadata for the operation will be the type [IndexOperationMetadata][google.firestore.admin.v1.IndexOperationMetadata].

Parameters
Name	Description
`request`	`CreateIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Index, IndexOperationMetadata>`	The RPC response.

Overrides

FirestoreAdminClient.CreateIndex(CreateIndexRequest, CallSettings)

CreateIndexAsync(CreateIndexRequest, CallSettings)

public override Task<Operation<Index, IndexOperationMetadata>> CreateIndexAsync(CreateIndexRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`CreateIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Index, IndexOperationMetadata>>`	A Task containing the RPC response.

Overrides

FirestoreAdminClient.CreateIndexAsync(CreateIndexRequest, CallSettings)

DeleteIndex(DeleteIndexRequest, CallSettings)

public override void DeleteIndex(DeleteIndexRequest request, CallSettings callSettings = null)

Deletes a composite index.

Parameters
Name	Description
`request`	`DeleteIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

FirestoreAdminClient.DeleteIndex(DeleteIndexRequest, CallSettings)

DeleteIndexAsync(DeleteIndexRequest, CallSettings)

public override Task DeleteIndexAsync(DeleteIndexRequest request, CallSettings callSettings = null)

Deletes a composite index.

Parameters
Name	Description
`request`	`DeleteIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task`	A Task containing the RPC response.

Overrides

FirestoreAdminClient.DeleteIndexAsync(DeleteIndexRequest, CallSettings)

ExportDocuments(ExportDocumentsRequest, CallSettings)

public override Operation<ExportDocumentsResponse, ExportDocumentsMetadata> ExportDocuments(ExportDocumentsRequest request, CallSettings callSettings = null)

Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.

Parameters
Name	Description
`request`	`ExportDocumentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<ExportDocumentsResponse, ExportDocumentsMetadata>`	The RPC response.

Overrides

FirestoreAdminClient.ExportDocuments(ExportDocumentsRequest, CallSettings)

ExportDocumentsAsync(ExportDocumentsRequest, CallSettings)

public override Task<Operation<ExportDocumentsResponse, ExportDocumentsMetadata>> ExportDocumentsAsync(ExportDocumentsRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`ExportDocumentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<ExportDocumentsResponse, ExportDocumentsMetadata>>`	A Task containing the RPC response.

Overrides

FirestoreAdminClient.ExportDocumentsAsync(ExportDocumentsRequest, CallSettings)

GetField(GetFieldRequest, CallSettings)

public override Field GetField(GetFieldRequest request, CallSettings callSettings = null)

Gets the metadata and configuration for a Field.

Parameters
Name	Description
`request`	`GetFieldRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Field`	The RPC response.

Overrides

FirestoreAdminClient.GetField(GetFieldRequest, CallSettings)

GetFieldAsync(GetFieldRequest, CallSettings)

public override Task<Field> GetFieldAsync(GetFieldRequest request, CallSettings callSettings = null)

Gets the metadata and configuration for a Field.

Parameters
Name	Description
`request`	`GetFieldRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Field>`	A Task containing the RPC response.

Overrides

FirestoreAdminClient.GetFieldAsync(GetFieldRequest, CallSettings)

GetIndex(GetIndexRequest, CallSettings)

public override Index GetIndex(GetIndexRequest request, CallSettings callSettings = null)

Gets a composite index.

Parameters
Name	Description
`request`	`GetIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Index`	The RPC response.

Overrides

FirestoreAdminClient.GetIndex(GetIndexRequest, CallSettings)

GetIndexAsync(GetIndexRequest, CallSettings)

public override Task<Index> GetIndexAsync(GetIndexRequest request, CallSettings callSettings = null)

Gets a composite index.

Parameters
Name	Description
`request`	`GetIndexRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Index>`	A Task containing the RPC response.

Overrides

FirestoreAdminClient.GetIndexAsync(GetIndexRequest, CallSettings)

ImportDocuments(ImportDocumentsRequest, CallSettings)

public override Operation<Empty, ImportDocumentsMetadata> ImportDocuments(ImportDocumentsRequest request, CallSettings callSettings = null)

Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.

Parameters
Name	Description
`request`	`ImportDocumentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Empty, ImportDocumentsMetadata>`	The RPC response.

Overrides

FirestoreAdminClient.ImportDocuments(ImportDocumentsRequest, CallSettings)

ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)

public override Task<Operation<Empty, ImportDocumentsMetadata>> ImportDocumentsAsync(ImportDocumentsRequest request, CallSettings callSettings = null)

Parameters
Name	Description
`request`	`ImportDocumentsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Empty, ImportDocumentsMetadata>>`	A Task containing the RPC response.

Overrides

FirestoreAdminClient.ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)

ListFields(ListFieldsRequest, CallSettings)

public override PagedEnumerable<ListFieldsResponse, Field> ListFields(ListFieldsRequest request, CallSettings callSettings = null)

Lists the field configuration and metadata for this database.

Currently, [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] only supports listing fields that have been explicitly overridden. To issue this query, call [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields] with the filter set to indexConfig.usesAncestorConfig:false.

Parameters
Name	Description
`request`	`ListFieldsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListFieldsResponse, Field>`	A pageable sequence of Field resources.

Overrides

FirestoreAdminClient.ListFields(ListFieldsRequest, CallSettings)

ListFieldsAsync(ListFieldsRequest, CallSettings)

public override PagedAsyncEnumerable<ListFieldsResponse, Field> ListFieldsAsync(ListFieldsRequest request, CallSettings callSettings = null)

Lists the field configuration and metadata for this database.

Parameters
Name	Description
`request`	`ListFieldsRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListFieldsResponse, Field>`	A pageable asynchronous sequence of Field resources.

Overrides

FirestoreAdminClient.ListFieldsAsync(ListFieldsRequest, CallSettings)

ListIndexes(ListIndexesRequest, CallSettings)

public override PagedEnumerable<ListIndexesResponse, Index> ListIndexes(ListIndexesRequest request, CallSettings callSettings = null)

Lists composite indexes.

Parameters
Name	Description
`request`	`ListIndexesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedEnumerable<ListIndexesResponse, Index>`	A pageable sequence of Index resources.

Overrides

FirestoreAdminClient.ListIndexes(ListIndexesRequest, CallSettings)

ListIndexesAsync(ListIndexesRequest, CallSettings)

public override PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(ListIndexesRequest request, CallSettings callSettings = null)

Lists composite indexes.

Parameters
Name	Description
`request`	`ListIndexesRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`PagedAsyncEnumerable<ListIndexesResponse, Index>`	A pageable asynchronous sequence of Index resources.

Overrides

FirestoreAdminClient.ListIndexesAsync(ListIndexesRequest, CallSettings)

UpdateField(UpdateFieldRequest, CallSettings)

public override Operation<Field, FieldOperationMetadata> UpdateField(UpdateFieldRequest request, CallSettings callSettings = null)

Updates a field configuration. Currently, field updates apply only to single field index configuration. However, calls to [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField] should provide a field mask to avoid changing any configuration that the caller isn't aware of. The field mask should be specified as: { paths: "index_config" }.

This call returns a [google.longrunning.Operation][google.longrunning.Operation] which may be used to track the status of the field update. The metadata for the operation will be the type [FieldOperationMetadata][google.firestore.admin.v1.FieldOperationMetadata].

To configure the default field settings for the database, use the special Field with resource name: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Parameters
Name	Description
`request`	`UpdateFieldRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Operation<Field, FieldOperationMetadata>`	The RPC response.

Overrides

FirestoreAdminClient.UpdateField(UpdateFieldRequest, CallSettings)

UpdateFieldAsync(UpdateFieldRequest, CallSettings)

public override Task<Operation<Field, FieldOperationMetadata>> UpdateFieldAsync(UpdateFieldRequest request, CallSettings callSettings = null)

To configure the default field settings for the database, use the special Field with resource name: projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.

Parameters
Name	Description
`request`	`UpdateFieldRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Returns
Type	Description
`Task<Operation<Field, FieldOperationMetadata>>`	A Task containing the RPC response.

Overrides

FirestoreAdminClient.UpdateFieldAsync(UpdateFieldRequest, CallSettings)