Firestore Admin v1 API - Class FirestoreAdmin.FirestoreAdminBase (3.8.0)

Version latest

• 3.8.0 (latest)
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.4.0
• 2.3.0
• 2.2.0

[BindServiceMethod(typeof(FirestoreAdmin), "BindService")]
public abstract class FirestoreAdmin.FirestoreAdminBase

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

Base class for server-side implementations of FirestoreAdmin

Inheritance

object > FirestoreAdmin.FirestoreAdminBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Methods

CreateBackupSchedule(CreateBackupScheduleRequest, ServerCallContext)

public virtual Task<BackupSchedule> CreateBackupSchedule(CreateBackupScheduleRequest request, ServerCallContext context)

Creates a backup schedule on a database. At most two backup schedules can be configured on a database, one daily backup schedule with retention up to 7 days and one weekly backup schedule with retention up to 14 weeks.

Parameters
Name	Description
request	CreateBackupScheduleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackupSchedule	The response to send back to the client (wrapped by a task).

CreateDatabase(CreateDatabaseRequest, ServerCallContext)

public virtual Task<Operation> CreateDatabase(CreateDatabaseRequest request, ServerCallContext context)

Create a database.

Parameters
Name	Description
request	CreateDatabaseRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateIndex(CreateIndexRequest, ServerCallContext)

public virtual Task<Operation> CreateIndex(CreateIndexRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteBackup(DeleteBackupRequest, ServerCallContext)

public virtual Task<Empty> DeleteBackup(DeleteBackupRequest request, ServerCallContext context)

Deletes a backup.

Parameters
Name	Description
request	DeleteBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteBackupSchedule(DeleteBackupScheduleRequest, ServerCallContext)

public virtual Task<Empty> DeleteBackupSchedule(DeleteBackupScheduleRequest request, ServerCallContext context)

Deletes a backup schedule.

Parameters
Name	Description
request	DeleteBackupScheduleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteDatabase(DeleteDatabaseRequest, ServerCallContext)

public virtual Task<Operation> DeleteDatabase(DeleteDatabaseRequest request, ServerCallContext context)

Deletes a database.

Parameters
Name	Description
request	DeleteDatabaseRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteIndex(DeleteIndexRequest, ServerCallContext)

public virtual Task<Empty> DeleteIndex(DeleteIndexRequest request, ServerCallContext context)

Deletes a composite index.

Parameters
Name	Description
request	DeleteIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

ExportDocuments(ExportDocumentsRequest, ServerCallContext)

public virtual Task<Operation> ExportDocuments(ExportDocumentsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetBackup(GetBackupRequest, ServerCallContext)

public virtual Task<Backup> GetBackup(GetBackupRequest request, ServerCallContext context)

Gets information about a backup.

Parameters
Name	Description
request	GetBackupRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackup	The response to send back to the client (wrapped by a task).

GetBackupSchedule(GetBackupScheduleRequest, ServerCallContext)

public virtual Task<BackupSchedule> GetBackupSchedule(GetBackupScheduleRequest request, ServerCallContext context)

Gets information about a backup schedule.

Parameters
Name	Description
request	GetBackupScheduleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackupSchedule	The response to send back to the client (wrapped by a task).

GetDatabase(GetDatabaseRequest, ServerCallContext)

public virtual Task<Database> GetDatabase(GetDatabaseRequest request, ServerCallContext context)

Gets information about a database.

Parameters
Name	Description
request	GetDatabaseRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDatabase	The response to send back to the client (wrapped by a task).

GetField(GetFieldRequest, ServerCallContext)

public virtual Task<Field> GetField(GetFieldRequest request, ServerCallContext context)

Gets the metadata and configuration for a Field.

Parameters
Name	Description
request	GetFieldRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskField	The response to send back to the client (wrapped by a task).

GetIndex(GetIndexRequest, ServerCallContext)

public virtual Task<Index> GetIndex(GetIndexRequest request, ServerCallContext context)

Gets a composite index.

Parameters
Name	Description
request	GetIndexRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskIndex	The response to send back to the client (wrapped by a task).

ImportDocuments(ImportDocumentsRequest, ServerCallContext)

public virtual Task<Operation> ImportDocuments(ImportDocumentsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListBackupSchedules(ListBackupSchedulesRequest, ServerCallContext)

public virtual Task<ListBackupSchedulesResponse> ListBackupSchedules(ListBackupSchedulesRequest request, ServerCallContext context)

List backup schedules.

Parameters
Name	Description
request	ListBackupSchedulesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListBackupSchedulesResponse	The response to send back to the client (wrapped by a task).

ListBackups(ListBackupsRequest, ServerCallContext)

public virtual Task<ListBackupsResponse> ListBackups(ListBackupsRequest request, ServerCallContext context)

Lists all the backups.

Parameters
Name	Description
request	ListBackupsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListBackupsResponse	The response to send back to the client (wrapped by a task).

ListDatabases(ListDatabasesRequest, ServerCallContext)

public virtual Task<ListDatabasesResponse> ListDatabases(ListDatabasesRequest request, ServerCallContext context)

List all the databases in the project.

Parameters
Name	Description
request	ListDatabasesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListDatabasesResponse	The response to send back to the client (wrapped by a task).

ListFields(ListFieldsRequest, ServerCallContext)

public virtual Task<ListFieldsResponse> ListFields(ListFieldsRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListFieldsResponse	The response to send back to the client (wrapped by a task).

ListIndexes(ListIndexesRequest, ServerCallContext)

public virtual Task<ListIndexesResponse> ListIndexes(ListIndexesRequest request, ServerCallContext context)

Lists composite indexes.

Parameters
Name	Description
request	ListIndexesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListIndexesResponse	The response to send back to the client (wrapped by a task).

RestoreDatabase(RestoreDatabaseRequest, ServerCallContext)

public virtual Task<Operation> RestoreDatabase(RestoreDatabaseRequest request, ServerCallContext context)

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.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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateBackupSchedule(UpdateBackupScheduleRequest, ServerCallContext)

public virtual Task<BackupSchedule> UpdateBackupSchedule(UpdateBackupScheduleRequest request, ServerCallContext context)

Updates a backup schedule.

Parameters
Name	Description
request	UpdateBackupScheduleRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskBackupSchedule	The response to send back to the client (wrapped by a task).

UpdateDatabase(UpdateDatabaseRequest, ServerCallContext)

public virtual Task<Operation> UpdateDatabase(UpdateDatabaseRequest request, ServerCallContext context)

Updates a database.

Parameters
Name	Description
request	UpdateDatabaseRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateField(UpdateFieldRequest, ServerCallContext)

public virtual Task<Operation> UpdateField(UpdateFieldRequest request, ServerCallContext context)

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 received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).