Firestore Admin v1 API - Class FirestoreAdminClientImpl (3.11.0) 

public sealed class FirestoreAdminClientImpl : FirestoreAdminClient

Reference documentation and code samples for the Firestore Admin v1 API class FirestoreAdminClientImpl.

FirestoreAdmin client wrapper implementation, for convenient use.

Inheritance

object > FirestoreAdminClient > FirestoreAdminClientImpl

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

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(FirestoreAdminClient, FirestoreAdminSettings, ILogger)

public FirestoreAdminClientImpl(FirestoreAdmin.FirestoreAdminClient grpcClient, FirestoreAdminSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient FirestoreAdminFirestoreAdminClient

The underlying gRPC client.
settings FirestoreAdminSettings

The base FirestoreAdminSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

BulkDeleteDocumentsOperationsClient

public override OperationsClient BulkDeleteDocumentsOperationsClient { get; }

The long-running operations client for BulkDeleteDocuments.

Property Value
Type Description
OperationsClient
Overrides

CreateDatabaseOperationsClient

public override OperationsClient CreateDatabaseOperationsClient { get; }

The long-running operations client for CreateDatabase.

Property Value
Type Description
OperationsClient
Overrides

CreateIndexOperationsClient

public override OperationsClient CreateIndexOperationsClient { get; }

The long-running operations client for CreateIndex.

Property Value
Type Description
OperationsClient
Overrides

DeleteDatabaseOperationsClient

public override OperationsClient DeleteDatabaseOperationsClient { get; }

The long-running operations client for DeleteDatabase.

Property Value
Type Description
OperationsClient
Overrides

ExportDocumentsOperationsClient

public override OperationsClient ExportDocumentsOperationsClient { get; }

The long-running operations client for ExportDocuments.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override FirestoreAdmin.FirestoreAdminClient GrpcClient { get; }

The underlying gRPC FirestoreAdmin client

Property Value
Type Description
FirestoreAdminFirestoreAdminClient
Overrides

ImportDocumentsOperationsClient

public override OperationsClient ImportDocumentsOperationsClient { get; }

The long-running operations client for ImportDocuments.

Property Value
Type Description
OperationsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RestoreDatabaseOperationsClient

public override OperationsClient RestoreDatabaseOperationsClient { get; }

The long-running operations client for RestoreDatabase.

Property Value
Type Description
OperationsClient
Overrides

UpdateDatabaseOperationsClient

public override OperationsClient UpdateDatabaseOperationsClient { get; }

The long-running operations client for UpdateDatabase.

Property Value
Type Description
OperationsClient
Overrides

UpdateFieldOperationsClient

public override OperationsClient UpdateFieldOperationsClient { get; }

The long-running operations client for UpdateField.

Property Value
Type Description
OperationsClient
Overrides

Methods

BulkDeleteDocuments(BulkDeleteDocumentsRequest, CallSettings)

public override Operation<BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata> BulkDeleteDocuments(BulkDeleteDocumentsRequest request, CallSettings callSettings = null)

Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created.

For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete

Parameters
Name Description
request BulkDeleteDocumentsRequest

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
OperationBulkDeleteDocumentsResponseBulkDeleteDocumentsMetadata

The RPC response.
Overrides

BulkDeleteDocumentsAsync(BulkDeleteDocumentsRequest, CallSettings)

public override Task<Operation<BulkDeleteDocumentsResponse, BulkDeleteDocumentsMetadata>> BulkDeleteDocumentsAsync(BulkDeleteDocumentsRequest request, CallSettings callSettings = null)

Bulk deletes a subset of documents from Google Cloud Firestore. Documents created or updated after the underlying system starts to process the request will not be deleted. The bulk delete occurs in the background and its progress can be monitored and managed via the Operation resource that is created.

For more details on bulk delete behavior, refer to: https://cloud.google.com/firestore/docs/manage-data/bulk-delete

Parameters
Name Description
request BulkDeleteDocumentsRequest

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
TaskOperationBulkDeleteDocumentsResponseBulkDeleteDocumentsMetadata

A Task containing the RPC response.
Overrides

CreateBackupSchedule(CreateBackupScheduleRequest, CallSettings)

public override BackupSchedule CreateBackupSchedule(CreateBackupScheduleRequest request, CallSettings callSettings = null)

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.

Parameters
Name Description
request CreateBackupScheduleRequest

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
BackupSchedule

The RPC response.
Overrides

CreateBackupScheduleAsync(CreateBackupScheduleRequest, CallSettings)

public override Task<BackupSchedule> CreateBackupScheduleAsync(CreateBackupScheduleRequest request, CallSettings callSettings = null)

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule and one weekly backup schedule.

Parameters
Name Description
request CreateBackupScheduleRequest

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
TaskBackupSchedule

A Task containing the RPC response.
Overrides

CreateDatabase(CreateDatabaseRequest, CallSettings)

public override Operation<Database, CreateDatabaseMetadata> CreateDatabase(CreateDatabaseRequest request, CallSettings callSettings = null)

Create a database.

Parameters
Name Description
request CreateDatabaseRequest

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
OperationDatabaseCreateDatabaseMetadata

The RPC response.
Overrides

CreateDatabaseAsync(CreateDatabaseRequest, CallSettings)

public override Task<Operation<Database, CreateDatabaseMetadata>> CreateDatabaseAsync(CreateDatabaseRequest request, CallSettings callSettings = null)

Create a database.

Parameters
Name Description
request CreateDatabaseRequest

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
TaskOperationDatabaseCreateDatabaseMetadata

A Task containing the RPC response.
Overrides

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
OperationIndexIndexOperationMetadata

The RPC response.
Overrides

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 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
TaskOperationIndexIndexOperationMetadata

A Task containing the RPC response.
Overrides

DeleteBackup(DeleteBackupRequest, CallSettings)

public override void DeleteBackup(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a backup.

Parameters
Name Description
request DeleteBackupRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteBackupAsync(DeleteBackupRequest, CallSettings)

public override Task DeleteBackupAsync(DeleteBackupRequest request, CallSettings callSettings = null)

Deletes a backup.

Parameters
Name Description
request DeleteBackupRequest

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

DeleteBackupSchedule(DeleteBackupScheduleRequest, CallSettings)

public override void DeleteBackupSchedule(DeleteBackupScheduleRequest request, CallSettings callSettings = null)

Deletes a backup schedule.

Parameters
Name Description
request DeleteBackupScheduleRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Overrides

DeleteBackupScheduleAsync(DeleteBackupScheduleRequest, CallSettings)

public override Task DeleteBackupScheduleAsync(DeleteBackupScheduleRequest request, CallSettings callSettings = null)

Deletes a backup schedule.

Parameters
Name Description
request DeleteBackupScheduleRequest

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

DeleteDatabase(DeleteDatabaseRequest, CallSettings)

public override Operation<Database, DeleteDatabaseMetadata> DeleteDatabase(DeleteDatabaseRequest request, CallSettings callSettings = null)

Deletes a database.

Parameters
Name Description
request DeleteDatabaseRequest

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
OperationDatabaseDeleteDatabaseMetadata

The RPC response.
Overrides

DeleteDatabaseAsync(DeleteDatabaseRequest, CallSettings)

public override Task<Operation<Database, DeleteDatabaseMetadata>> DeleteDatabaseAsync(DeleteDatabaseRequest request, CallSettings callSettings = null)

Deletes a database.

Parameters
Name Description
request DeleteDatabaseRequest

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
TaskOperationDatabaseDeleteDatabaseMetadata

A Task containing the RPC response.
Overrides

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

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

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 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
OperationExportDocumentsResponseExportDocumentsMetadata

The RPC response.
Overrides

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 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
TaskOperationExportDocumentsResponseExportDocumentsMetadata

A Task containing the RPC response.
Overrides

GetBackup(GetBackupRequest, CallSettings)

public override Backup GetBackup(GetBackupRequest request, CallSettings callSettings = null)

Gets information about a backup.

Parameters
Name Description
request GetBackupRequest

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
Backup

The RPC response.
Overrides

GetBackupAsync(GetBackupRequest, CallSettings)

public override Task<Backup> GetBackupAsync(GetBackupRequest request, CallSettings callSettings = null)

Gets information about a backup.

Parameters
Name Description
request GetBackupRequest

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
TaskBackup

A Task containing the RPC response.
Overrides

GetBackupSchedule(GetBackupScheduleRequest, CallSettings)

public override BackupSchedule GetBackupSchedule(GetBackupScheduleRequest request, CallSettings callSettings = null)

Gets information about a backup schedule.

Parameters
Name Description
request GetBackupScheduleRequest

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
BackupSchedule

The RPC response.
Overrides

GetBackupScheduleAsync(GetBackupScheduleRequest, CallSettings)

public override Task<BackupSchedule> GetBackupScheduleAsync(GetBackupScheduleRequest request, CallSettings callSettings = null)

Gets information about a backup schedule.

Parameters
Name Description
request GetBackupScheduleRequest

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
TaskBackupSchedule

A Task containing the RPC response.
Overrides

GetDatabase(GetDatabaseRequest, CallSettings)

public override Database GetDatabase(GetDatabaseRequest request, CallSettings callSettings = null)

Gets information about a database.

Parameters
Name Description
request GetDatabaseRequest

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
Database

The RPC response.
Overrides

GetDatabaseAsync(GetDatabaseRequest, CallSettings)

public override Task<Database> GetDatabaseAsync(GetDatabaseRequest request, CallSettings callSettings = null)

Gets information about a database.

Parameters
Name Description
request GetDatabaseRequest

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
TaskDatabase

A Task containing the RPC response.
Overrides

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

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
TaskField

A Task containing the RPC response.
Overrides

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

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
TaskIndex

A Task containing the RPC response.
Overrides

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
OperationEmptyImportDocumentsMetadata

The RPC response.
Overrides

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 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
TaskOperationEmptyImportDocumentsMetadata

A Task containing the RPC response.
Overrides

ListBackupSchedules(ListBackupSchedulesRequest, CallSettings)

public override ListBackupSchedulesResponse ListBackupSchedules(ListBackupSchedulesRequest request, CallSettings callSettings = null)

List backup schedules.

Parameters
Name Description
request ListBackupSchedulesRequest

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
ListBackupSchedulesResponse

The RPC response.
Overrides

ListBackupSchedulesAsync(ListBackupSchedulesRequest, CallSettings)

public override Task<ListBackupSchedulesResponse> ListBackupSchedulesAsync(ListBackupSchedulesRequest request, CallSettings callSettings = null)

List backup schedules.

Parameters
Name Description
request ListBackupSchedulesRequest

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
TaskListBackupSchedulesResponse

A Task containing the RPC response.
Overrides

ListBackups(ListBackupsRequest, CallSettings)

public override ListBackupsResponse ListBackups(ListBackupsRequest request, CallSettings callSettings = null)

Lists all the backups.

Parameters
Name Description
request ListBackupsRequest

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
ListBackupsResponse

The RPC response.
Overrides

ListBackupsAsync(ListBackupsRequest, CallSettings)

public override Task<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallSettings callSettings = null)

Lists all the backups.

Parameters
Name Description
request ListBackupsRequest

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
TaskListBackupsResponse

A Task containing the RPC response.
Overrides

ListDatabases(ListDatabasesRequest, CallSettings)

public override ListDatabasesResponse ListDatabases(ListDatabasesRequest request, CallSettings callSettings = null)

List all the databases in the project.

Parameters
Name Description
request ListDatabasesRequest

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
ListDatabasesResponse

The RPC response.
Overrides

ListDatabasesAsync(ListDatabasesRequest, CallSettings)

public override Task<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, CallSettings callSettings = null)

List all the databases in the project.

Parameters
Name Description
request ListDatabasesRequest

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
TaskListDatabasesResponse

A Task containing the RPC response.
Overrides

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 or ttlConfig:*.

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
PagedEnumerableListFieldsResponseField

A pageable sequence of Field resources.
Overrides

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 or ttlConfig:*.

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
PagedAsyncEnumerableListFieldsResponseField

A pageable asynchronous sequence of Field resources.
Overrides

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
PagedEnumerableListIndexesResponseIndex

A pageable sequence of Index resources.
Overrides

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
PagedAsyncEnumerableListIndexesResponseIndex

A pageable asynchronous sequence of Index resources.
Overrides

RestoreDatabase(RestoreDatabaseRequest, CallSettings)

public override Operation<Database, RestoreDatabaseMetadata> RestoreDatabase(RestoreDatabaseRequest request, CallSettings callSettings = null)

Creates a new database by restoring from an existing backup.

The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase] except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup.

The [long-running operation][google.longrunning.Operation] can be used to track the progress of the restore, with the Operation's [metadata][google.longrunning.Operation.metadata] field type being the [RestoreDatabaseMetadata][google.firestore.admin.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is the [Database][google.firestore.admin.v1.Database] if the restore was successful. The new database is not readable or writeable until the LRO has completed.

Parameters
Name Description
request RestoreDatabaseRequest

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
OperationDatabaseRestoreDatabaseMetadata

The RPC response.
Overrides

RestoreDatabaseAsync(RestoreDatabaseRequest, CallSettings)

public override Task<Operation<Database, RestoreDatabaseMetadata>> RestoreDatabaseAsync(RestoreDatabaseRequest request, CallSettings callSettings = null)

Creates a new database by restoring from an existing backup.

The new database must be in the same cloud region or multi-region location as the existing backup. This behaves similar to [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase] except instead of creating a new empty database, a new database is created with the database type, index configuration, and documents from an existing backup.

The [long-running operation][google.longrunning.Operation] can be used to track the progress of the restore, with the Operation's [metadata][google.longrunning.Operation.metadata] field type being the [RestoreDatabaseMetadata][google.firestore.admin.v1.RestoreDatabaseMetadata]. The [response][google.longrunning.Operation.response] type is the [Database][google.firestore.admin.v1.Database] if the restore was successful. The new database is not readable or writeable until the LRO has completed.

Parameters
Name Description
request RestoreDatabaseRequest

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
TaskOperationDatabaseRestoreDatabaseMetadata

A Task containing the RPC response.
Overrides

UpdateBackupSchedule(UpdateBackupScheduleRequest, CallSettings)

public override BackupSchedule UpdateBackupSchedule(UpdateBackupScheduleRequest request, CallSettings callSettings = null)

Updates a backup schedule.

Parameters
Name Description
request UpdateBackupScheduleRequest

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
BackupSchedule

The RPC response.
Overrides

UpdateBackupScheduleAsync(UpdateBackupScheduleRequest, CallSettings)

public override Task<BackupSchedule> UpdateBackupScheduleAsync(UpdateBackupScheduleRequest request, CallSettings callSettings = null)

Updates a backup schedule.

Parameters
Name Description
request UpdateBackupScheduleRequest

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
TaskBackupSchedule

A Task containing the RPC response.
Overrides

UpdateDatabase(UpdateDatabaseRequest, CallSettings)

public override Operation<Database, UpdateDatabaseMetadata> UpdateDatabase(UpdateDatabaseRequest request, CallSettings callSettings = null)

Updates a database.

Parameters
Name Description
request UpdateDatabaseRequest

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
OperationDatabaseUpdateDatabaseMetadata

The RPC response.
Overrides

UpdateDatabaseAsync(UpdateDatabaseRequest, CallSettings)

public override Task<Operation<Database, UpdateDatabaseMetadata>> UpdateDatabaseAsync(UpdateDatabaseRequest request, CallSettings callSettings = null)

Updates a database.

Parameters
Name Description
request UpdateDatabaseRequest

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
TaskOperationDatabaseUpdateDatabaseMetadata

A Task containing the RPC response.
Overrides

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
OperationFieldFieldOperationMetadata

The RPC response.
Overrides

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 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
TaskOperationFieldFieldOperationMetadata

A Task containing the RPC response.
Overrides