public sealed class FirestoreAdminClientImpl : FirestoreAdminClientFirestoreAdmin client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Firestore.Admin.V1Assembly
Google.Cloud.Firestore.Admin.V1.dll
Remarks
The Cloud Firestore Admin API.
This API provides several administrative services for Cloud Firestore.
Project, Database, Namespace, Collection, Collection Group, and Document are used as defined in the Google Cloud Firestore API.
Operation: An Operation represents work being performed in the background.
The index service manages Cloud Firestore indexes.
Index creation is performed asynchronously. An Operation resource is created for each such asynchronous operation. The state of the operation (including any errors encountered) may be queried via the Operation resource.
The Operations collection provides a record of actions performed for the specified Project (including any Operations in progress). Operations are not created directly but through calls on other collections or resources.
An Operation that is done may be deleted so that it is no longer listed as
part of the Operation collection. Operations are garbage collected after
30 days. By default, ListOperations will only return in progress and failed
operations. To list completed operation, issue a ListOperations request with
the filter done: true.
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.FirestoreAdminClientThe underlying gRPC client. |
settings | FirestoreAdminSettingsThe 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 | |
ExportDocumentsOperationsClient
public override OperationsClient ExportDocumentsOperationsClient { get; }The long-running operations client for ExportDocuments.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
GrpcClient
public override FirestoreAdmin.FirestoreAdminClient GrpcClient { get; }The underlying gRPC FirestoreAdmin client
| Property Value | |
|---|---|
| Type | Description |
FirestoreAdmin.FirestoreAdminClient | |
ImportDocumentsOperationsClient
public override OperationsClient ImportDocumentsOperationsClient { get; }The long-running operations client for ImportDocuments.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateDatabaseOperationsClient
public override OperationsClient UpdateDatabaseOperationsClient { get; }The long-running operations client for UpdateDatabase.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
UpdateFieldOperationsClient
public override OperationsClient UpdateFieldOperationsClient { get; }The long-running operations client for UpdateField.
| Property Value | |
|---|---|
| Type | Description |
OperationsClient | |
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 | CreateIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Index, IndexOperationMetadata> | The RPC response. |
CreateIndexAsync(CreateIndexRequest, CallSettings)
public override Task<Operation<Index, IndexOperationMetadata>> CreateIndexAsync(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 | CreateIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Index, IndexOperationMetadata>> | A Task containing the RPC response. |
DeleteIndex(DeleteIndexRequest, CallSettings)
public override void DeleteIndex(DeleteIndexRequest request, CallSettings callSettings = null)Deletes a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
DeleteIndexAsync(DeleteIndexRequest, CallSettings)
public override Task DeleteIndexAsync(DeleteIndexRequest request, CallSettings callSettings = null)Deletes a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | DeleteIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task | A Task containing the RPC response. |
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.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<ExportDocumentsResponse, ExportDocumentsMetadata> | The RPC response. |
ExportDocumentsAsync(ExportDocumentsRequest, CallSettings)
public override Task<Operation<ExportDocumentsResponse, ExportDocumentsMetadata>> ExportDocumentsAsync(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.
For more details on export behavior and output format, refer to: https://cloud.google.com/firestore/docs/manage-data/export-import
| Parameters | |
|---|---|
| Name | Description |
request | ExportDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<ExportDocumentsResponse, ExportDocumentsMetadata>> | A Task containing the RPC response. |
GetDatabase(GetDatabaseRequest, CallSettings)
public override Database GetDatabase(GetDatabaseRequest request, CallSettings callSettings = null)Gets information about a database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Database | The RPC response. |
GetDatabaseAsync(GetDatabaseRequest, CallSettings)
public override Task<Database> GetDatabaseAsync(GetDatabaseRequest request, CallSettings callSettings = null)Gets information about a database.
| Parameters | |
|---|---|
| Name | Description |
request | GetDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Database> | A Task containing the RPC response. |
GetField(GetFieldRequest, CallSettings)
public override Field GetField(GetFieldRequest request, CallSettings callSettings = null)Gets the metadata and configuration for a Field.
| Parameters | |
|---|---|
| Name | Description |
request | GetFieldRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Field | The RPC response. |
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 | GetFieldRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Field> | A Task containing the RPC response. |
GetIndex(GetIndexRequest, CallSettings)
public override Index GetIndex(GetIndexRequest request, CallSettings callSettings = null)Gets a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Index | The RPC response. |
GetIndexAsync(GetIndexRequest, CallSettings)
public override Task<Index> GetIndexAsync(GetIndexRequest request, CallSettings callSettings = null)Gets a composite index.
| Parameters | |
|---|---|
| Name | Description |
request | GetIndexRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Index> | A Task containing the RPC response. |
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 | ImportDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Empty, ImportDocumentsMetadata> | The RPC response. |
ImportDocumentsAsync(ImportDocumentsRequest, CallSettings)
public override Task<Operation<Empty, ImportDocumentsMetadata>> ImportDocumentsAsync(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 | ImportDocumentsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Empty, ImportDocumentsMetadata>> | A Task containing the RPC response. |
ListDatabases(ListDatabasesRequest, CallSettings)
public override ListDatabasesResponse ListDatabases(ListDatabasesRequest request, CallSettings callSettings = null)List all the databases in the project.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
ListDatabasesResponse | The RPC response. |
ListDatabasesAsync(ListDatabasesRequest, CallSettings)
public override Task<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, CallSettings callSettings = null)List all the databases in the project.
| Parameters | |
|---|---|
| Name | Description |
request | ListDatabasesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<ListDatabasesResponse> | A Task containing the RPC response. |
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 | ListFieldsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListFieldsResponse, Field> | A pageable sequence of Field resources. |
ListFieldsAsync(ListFieldsRequest, CallSettings)
public override PagedAsyncEnumerable<ListFieldsResponse, Field> ListFieldsAsync(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 | ListFieldsRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListFieldsResponse, Field> | A pageable asynchronous sequence of Field resources. |
ListIndexes(ListIndexesRequest, CallSettings)
public override PagedEnumerable<ListIndexesResponse, Index> ListIndexes(ListIndexesRequest request, CallSettings callSettings = null)Lists composite indexes.
| Parameters | |
|---|---|
| Name | Description |
request | ListIndexesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedEnumerable<ListIndexesResponse, Index> | A pageable sequence of Index resources. |
ListIndexesAsync(ListIndexesRequest, CallSettings)
public override PagedAsyncEnumerable<ListIndexesResponse, Index> ListIndexesAsync(ListIndexesRequest request, CallSettings callSettings = null)Lists composite indexes.
| Parameters | |
|---|---|
| Name | Description |
request | ListIndexesRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
PagedAsyncEnumerable<ListIndexesResponse, Index> | A pageable asynchronous sequence of Index resources. |
UpdateDatabase(UpdateDatabaseRequest, CallSettings)
public override Operation<Database, UpdateDatabaseMetadata> UpdateDatabase(UpdateDatabaseRequest request, CallSettings callSettings = null)Updates a database.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Database, UpdateDatabaseMetadata> | The RPC response. |
UpdateDatabaseAsync(UpdateDatabaseRequest, CallSettings)
public override Task<Operation<Database, UpdateDatabaseMetadata>> UpdateDatabaseAsync(UpdateDatabaseRequest request, CallSettings callSettings = null)Updates a database.
| Parameters | |
|---|---|
| Name | Description |
request | UpdateDatabaseRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Database, UpdateDatabaseMetadata>> | A Task containing the RPC response. |
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 | UpdateFieldRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Operation<Field, FieldOperationMetadata> | The RPC response. |
UpdateFieldAsync(UpdateFieldRequest, CallSettings)
public override Task<Operation<Field, FieldOperationMetadata>> UpdateFieldAsync(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 | UpdateFieldRequestThe request object containing all of the parameters for the API call. |
callSettings | CallSettingsIf not null, applies overrides to this RPC call. |
| Returns | |
|---|---|
| Type | Description |
Task<Operation<Field, FieldOperationMetadata>> | A Task containing the RPC response. |