Firestore Admin v1 API - Class FirestoreAdmin.FirestoreAdminClient (3.7.0)

public class FirestoreAdmin.FirestoreAdminClient : ClientBase<FirestoreAdmin.FirestoreAdminClient>

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

Client for FirestoreAdmin

Inheritance

object > ClientBase > ClientBaseFirestoreAdminFirestoreAdminClient > FirestoreAdmin.FirestoreAdminClient

Namespace

Google.Cloud.Firestore.Admin.V1

Assembly

Google.Cloud.Firestore.Admin.V1.dll

Constructors

FirestoreAdminClient()

protected FirestoreAdminClient()

Protected parameterless constructor to allow creation of test doubles.

FirestoreAdminClient(CallInvoker)

public FirestoreAdminClient(CallInvoker callInvoker)

Creates a new client for FirestoreAdmin that uses a custom CallInvoker.

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

FirestoreAdminClient(ChannelBase)

public FirestoreAdminClient(ChannelBase channel)

Creates a new client for FirestoreAdmin

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

FirestoreAdminClient(ClientBaseConfiguration)

protected FirestoreAdminClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateBackupSchedule(CreateBackupScheduleRequest, CallOptions)

public virtual BackupSchedule CreateBackupSchedule(CreateBackupScheduleRequest request, CallOptions options)

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
NameDescription
requestCreateBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackupSchedule

The response received from the server.

CreateBackupSchedule(CreateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual BackupSchedule CreateBackupSchedule(CreateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestCreateBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
BackupSchedule

The response received from the server.

CreateBackupScheduleAsync(CreateBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<BackupSchedule> CreateBackupScheduleAsync(CreateBackupScheduleRequest request, CallOptions options)

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
NameDescription
requestCreateBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackupSchedule

The call object.

CreateBackupScheduleAsync(CreateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackupSchedule> CreateBackupScheduleAsync(CreateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestCreateBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallBackupSchedule

The call object.

CreateDatabase(CreateDatabaseRequest, CallOptions)

public virtual Operation CreateDatabase(CreateDatabaseRequest request, CallOptions options)

Create a database.

Parameters
NameDescription
requestCreateDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateDatabase(CreateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateDatabase(CreateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a database.

Parameters
NameDescription
requestCreateDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateDatabaseAsync(CreateDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateDatabaseAsync(CreateDatabaseRequest request, CallOptions options)

Create a database.

Parameters
NameDescription
requestCreateDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateDatabaseAsync(CreateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateDatabaseAsync(CreateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Create a database.

Parameters
NameDescription
requestCreateDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateIndex(CreateIndexRequest, CallOptions)

public virtual Operation CreateIndex(CreateIndexRequest request, CallOptions options)

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
NameDescription
requestCreateIndexRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateIndex(CreateIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation CreateIndex(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestCreateIndexRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

CreateIndexAsync(CreateIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, CallOptions options)

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
NameDescription
requestCreateIndexRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateIndexAsync(CreateIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateIndexAsync(CreateIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestCreateIndexRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
TypeDescription
LocationsLocationsClient

A new Locations.LocationsClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
TypeDescription
OperationsOperationsClient

A new Operations client for the same target as this client.

DeleteBackup(DeleteBackupRequest, CallOptions)

public virtual Empty DeleteBackup(DeleteBackupRequest request, CallOptions options)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteBackup(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteBackup(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteBackupAsync(DeleteBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteBackupAsync(DeleteBackupRequest request, CallOptions options)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteBackupAsync(DeleteBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteBackupAsync(DeleteBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup.

Parameters
NameDescription
requestDeleteBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteBackupSchedule(DeleteBackupScheduleRequest, CallOptions)

public virtual Empty DeleteBackupSchedule(DeleteBackupScheduleRequest request, CallOptions options)

Deletes a backup schedule.

Parameters
NameDescription
requestDeleteBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteBackupSchedule(DeleteBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteBackupSchedule(DeleteBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup schedule.

Parameters
NameDescription
requestDeleteBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteBackupScheduleAsync(DeleteBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteBackupScheduleAsync(DeleteBackupScheduleRequest request, CallOptions options)

Deletes a backup schedule.

Parameters
NameDescription
requestDeleteBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteBackupScheduleAsync(DeleteBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteBackupScheduleAsync(DeleteBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a backup schedule.

Parameters
NameDescription
requestDeleteBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteDatabase(DeleteDatabaseRequest, CallOptions)

public virtual Operation DeleteDatabase(DeleteDatabaseRequest request, CallOptions options)

Deletes a database.

Parameters
NameDescription
requestDeleteDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteDatabase(DeleteDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation DeleteDatabase(DeleteDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a database.

Parameters
NameDescription
requestDeleteDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

DeleteDatabaseAsync(DeleteDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteDatabaseAsync(DeleteDatabaseRequest request, CallOptions options)

Deletes a database.

Parameters
NameDescription
requestDeleteDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteDatabaseAsync(DeleteDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteDatabaseAsync(DeleteDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a database.

Parameters
NameDescription
requestDeleteDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

DeleteIndex(DeleteIndexRequest, CallOptions)

public virtual Empty DeleteIndex(DeleteIndexRequest request, CallOptions options)

Deletes a composite index.

Parameters
NameDescription
requestDeleteIndexRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteIndex(DeleteIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteIndex(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a composite index.

Parameters
NameDescription
requestDeleteIndexRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Empty

The response received from the server.

DeleteIndexAsync(DeleteIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteIndexAsync(DeleteIndexRequest request, CallOptions options)

Deletes a composite index.

Parameters
NameDescription
requestDeleteIndexRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

DeleteIndexAsync(DeleteIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteIndexAsync(DeleteIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Deletes a composite index.

Parameters
NameDescription
requestDeleteIndexRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallEmpty

The call object.

ExportDocuments(ExportDocumentsRequest, CallOptions)

public virtual Operation ExportDocuments(ExportDocumentsRequest request, CallOptions options)

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
NameDescription
requestExportDocumentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportDocuments(ExportDocumentsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportDocuments(ExportDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestExportDocumentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ExportDocumentsAsync(ExportDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportDocumentsAsync(ExportDocumentsRequest request, CallOptions options)

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
NameDescription
requestExportDocumentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ExportDocumentsAsync(ExportDocumentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportDocumentsAsync(ExportDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestExportDocumentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

GetBackup(GetBackupRequest, CallOptions)

public virtual Backup GetBackup(GetBackupRequest request, CallOptions options)

Gets information about a backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Backup

The response received from the server.

GetBackup(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual Backup GetBackup(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Backup

The response received from the server.

GetBackupAsync(GetBackupRequest, CallOptions)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, CallOptions options)

Gets information about a backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackup

The call object.

GetBackupAsync(GetBackupRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Backup> GetBackupAsync(GetBackupRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a backup.

Parameters
NameDescription
requestGetBackupRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallBackup

The call object.

GetBackupSchedule(GetBackupScheduleRequest, CallOptions)

public virtual BackupSchedule GetBackupSchedule(GetBackupScheduleRequest request, CallOptions options)

Gets information about a backup schedule.

Parameters
NameDescription
requestGetBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackupSchedule

The response received from the server.

GetBackupSchedule(GetBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual BackupSchedule GetBackupSchedule(GetBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a backup schedule.

Parameters
NameDescription
requestGetBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
BackupSchedule

The response received from the server.

GetBackupScheduleAsync(GetBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<BackupSchedule> GetBackupScheduleAsync(GetBackupScheduleRequest request, CallOptions options)

Gets information about a backup schedule.

Parameters
NameDescription
requestGetBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackupSchedule

The call object.

GetBackupScheduleAsync(GetBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackupSchedule> GetBackupScheduleAsync(GetBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a backup schedule.

Parameters
NameDescription
requestGetBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallBackupSchedule

The call object.

GetDatabase(GetDatabaseRequest, CallOptions)

public virtual Database GetDatabase(GetDatabaseRequest request, CallOptions options)

Gets information about a database.

Parameters
NameDescription
requestGetDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Database

The response received from the server.

GetDatabase(GetDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Database GetDatabase(GetDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a database.

Parameters
NameDescription
requestGetDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Database

The response received from the server.

GetDatabaseAsync(GetDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Database> GetDatabaseAsync(GetDatabaseRequest request, CallOptions options)

Gets information about a database.

Parameters
NameDescription
requestGetDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallDatabase

The call object.

GetDatabaseAsync(GetDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Database> GetDatabaseAsync(GetDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets information about a database.

Parameters
NameDescription
requestGetDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallDatabase

The call object.

GetField(GetFieldRequest, CallOptions)

public virtual Field GetField(GetFieldRequest request, CallOptions options)

Gets the metadata and configuration for a Field.

Parameters
NameDescription
requestGetFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Field

The response received from the server.

GetField(GetFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual Field GetField(GetFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the metadata and configuration for a Field.

Parameters
NameDescription
requestGetFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Field

The response received from the server.

GetFieldAsync(GetFieldRequest, CallOptions)

public virtual AsyncUnaryCall<Field> GetFieldAsync(GetFieldRequest request, CallOptions options)

Gets the metadata and configuration for a Field.

Parameters
NameDescription
requestGetFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallField

The call object.

GetFieldAsync(GetFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Field> GetFieldAsync(GetFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the metadata and configuration for a Field.

Parameters
NameDescription
requestGetFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallField

The call object.

GetIndex(GetIndexRequest, CallOptions)

public virtual Index GetIndex(GetIndexRequest request, CallOptions options)

Gets a composite index.

Parameters
NameDescription
requestGetIndexRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Index

The response received from the server.

GetIndex(GetIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual Index GetIndex(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a composite index.

Parameters
NameDescription
requestGetIndexRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Index

The response received from the server.

GetIndexAsync(GetIndexRequest, CallOptions)

public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, CallOptions options)

Gets a composite index.

Parameters
NameDescription
requestGetIndexRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallIndex

The call object.

GetIndexAsync(GetIndexRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Index> GetIndexAsync(GetIndexRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets a composite index.

Parameters
NameDescription
requestGetIndexRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallIndex

The call object.

ImportDocuments(ImportDocumentsRequest, CallOptions)

public virtual Operation ImportDocuments(ImportDocumentsRequest request, CallOptions options)

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
NameDescription
requestImportDocumentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportDocuments(ImportDocumentsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ImportDocuments(ImportDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestImportDocumentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

ImportDocumentsAsync(ImportDocumentsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, CallOptions options)

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
NameDescription
requestImportDocumentsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ImportDocumentsAsync(ImportDocumentsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ImportDocumentsAsync(ImportDocumentsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestImportDocumentsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

ListBackupSchedules(ListBackupSchedulesRequest, CallOptions)

public virtual ListBackupSchedulesResponse ListBackupSchedules(ListBackupSchedulesRequest request, CallOptions options)

List backup schedules.

Parameters
NameDescription
requestListBackupSchedulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListBackupSchedulesResponse

The response received from the server.

ListBackupSchedules(ListBackupSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupSchedulesResponse ListBackupSchedules(ListBackupSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List backup schedules.

Parameters
NameDescription
requestListBackupSchedulesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListBackupSchedulesResponse

The response received from the server.

ListBackupSchedulesAsync(ListBackupSchedulesRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupSchedulesResponse> ListBackupSchedulesAsync(ListBackupSchedulesRequest request, CallOptions options)

List backup schedules.

Parameters
NameDescription
requestListBackupSchedulesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListBackupSchedulesResponse

The call object.

ListBackupSchedulesAsync(ListBackupSchedulesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupSchedulesResponse> ListBackupSchedulesAsync(ListBackupSchedulesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List backup schedules.

Parameters
NameDescription
requestListBackupSchedulesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListBackupSchedulesResponse

The call object.

ListBackups(ListBackupsRequest, CallOptions)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, CallOptions options)

Lists all the backups.

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListBackupsResponse

The response received from the server.

ListBackups(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListBackupsResponse ListBackups(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the backups.

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListBackupsResponse

The response received from the server.

ListBackupsAsync(ListBackupsRequest, CallOptions)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, CallOptions options)

Lists all the backups.

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListBackupsResponse

The call object.

ListBackupsAsync(ListBackupsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListBackupsResponse> ListBackupsAsync(ListBackupsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists all the backups.

Parameters
NameDescription
requestListBackupsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListBackupsResponse

The call object.

ListDatabases(ListDatabasesRequest, CallOptions)

public virtual ListDatabasesResponse ListDatabases(ListDatabasesRequest request, CallOptions options)

List all the databases in the project.

Parameters
NameDescription
requestListDatabasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListDatabasesResponse

The response received from the server.

ListDatabases(ListDatabasesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListDatabasesResponse ListDatabases(ListDatabasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List all the databases in the project.

Parameters
NameDescription
requestListDatabasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListDatabasesResponse

The response received from the server.

ListDatabasesAsync(ListDatabasesRequest, CallOptions)

public virtual AsyncUnaryCall<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, CallOptions options)

List all the databases in the project.

Parameters
NameDescription
requestListDatabasesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListDatabasesResponse

The call object.

ListDatabasesAsync(ListDatabasesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListDatabasesResponse> ListDatabasesAsync(ListDatabasesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

List all the databases in the project.

Parameters
NameDescription
requestListDatabasesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListDatabasesResponse

The call object.

ListFields(ListFieldsRequest, CallOptions)

public virtual ListFieldsResponse ListFields(ListFieldsRequest request, CallOptions options)

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
NameDescription
requestListFieldsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListFieldsResponse

The response received from the server.

ListFields(ListFieldsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListFieldsResponse ListFields(ListFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestListFieldsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListFieldsResponse

The response received from the server.

ListFieldsAsync(ListFieldsRequest, CallOptions)

public virtual AsyncUnaryCall<ListFieldsResponse> ListFieldsAsync(ListFieldsRequest request, CallOptions options)

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
NameDescription
requestListFieldsRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListFieldsResponse

The call object.

ListFieldsAsync(ListFieldsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListFieldsResponse> ListFieldsAsync(ListFieldsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestListFieldsRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListFieldsResponse

The call object.

ListIndexes(ListIndexesRequest, CallOptions)

public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, CallOptions options)

Lists composite indexes.

Parameters
NameDescription
requestListIndexesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListIndexesResponse

The response received from the server.

ListIndexes(ListIndexesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListIndexesResponse ListIndexes(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists composite indexes.

Parameters
NameDescription
requestListIndexesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListIndexesResponse

The response received from the server.

ListIndexesAsync(ListIndexesRequest, CallOptions)

public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, CallOptions options)

Lists composite indexes.

Parameters
NameDescription
requestListIndexesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListIndexesResponse

The call object.

ListIndexesAsync(ListIndexesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListIndexesResponse> ListIndexesAsync(ListIndexesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists composite indexes.

Parameters
NameDescription
requestListIndexesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListIndexesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override FirestoreAdmin.FirestoreAdminClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
FirestoreAdminFirestoreAdminClient
Overrides

RestoreDatabase(RestoreDatabaseRequest, CallOptions)

public virtual Operation RestoreDatabase(RestoreDatabaseRequest request, CallOptions options)

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
NameDescription
requestRestoreDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

RestoreDatabase(RestoreDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation RestoreDatabase(RestoreDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestRestoreDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

RestoreDatabaseAsync(RestoreDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RestoreDatabaseAsync(RestoreDatabaseRequest request, CallOptions options)

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
NameDescription
requestRestoreDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

RestoreDatabaseAsync(RestoreDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> RestoreDatabaseAsync(RestoreDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestRestoreDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateBackupSchedule(UpdateBackupScheduleRequest, CallOptions)

public virtual BackupSchedule UpdateBackupSchedule(UpdateBackupScheduleRequest request, CallOptions options)

Updates a backup schedule.

Parameters
NameDescription
requestUpdateBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
BackupSchedule

The response received from the server.

UpdateBackupSchedule(UpdateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual BackupSchedule UpdateBackupSchedule(UpdateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a backup schedule.

Parameters
NameDescription
requestUpdateBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
BackupSchedule

The response received from the server.

UpdateBackupScheduleAsync(UpdateBackupScheduleRequest, CallOptions)

public virtual AsyncUnaryCall<BackupSchedule> UpdateBackupScheduleAsync(UpdateBackupScheduleRequest request, CallOptions options)

Updates a backup schedule.

Parameters
NameDescription
requestUpdateBackupScheduleRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallBackupSchedule

The call object.

UpdateBackupScheduleAsync(UpdateBackupScheduleRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<BackupSchedule> UpdateBackupScheduleAsync(UpdateBackupScheduleRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a backup schedule.

Parameters
NameDescription
requestUpdateBackupScheduleRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallBackupSchedule

The call object.

UpdateDatabase(UpdateDatabaseRequest, CallOptions)

public virtual Operation UpdateDatabase(UpdateDatabaseRequest request, CallOptions options)

Updates a database.

Parameters
NameDescription
requestUpdateDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateDatabase(UpdateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateDatabase(UpdateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a database.

Parameters
NameDescription
requestUpdateDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateDatabaseAsync(UpdateDatabaseRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateDatabaseAsync(UpdateDatabaseRequest request, CallOptions options)

Updates a database.

Parameters
NameDescription
requestUpdateDatabaseRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateDatabaseAsync(UpdateDatabaseRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateDatabaseAsync(UpdateDatabaseRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a database.

Parameters
NameDescription
requestUpdateDatabaseRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateField(UpdateFieldRequest, CallOptions)

public virtual Operation UpdateField(UpdateFieldRequest request, CallOptions options)

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
NameDescription
requestUpdateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateField(UpdateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation UpdateField(UpdateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestUpdateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
Operation

The response received from the server.

UpdateFieldAsync(UpdateFieldRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateFieldAsync(UpdateFieldRequest request, CallOptions options)

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
NameDescription
requestUpdateFieldRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.

UpdateFieldAsync(UpdateFieldRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateFieldAsync(UpdateFieldRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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
NameDescription
requestUpdateFieldRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallOperation

The call object.