Firestore Admin v1 API - Namespace Google.Cloud.Firestore.Admin.V1 (3.7.0)

A Backup of a Cloud Firestore Database.

The backup contains all documents and index configurations for the given database at a specific point in time.

Container for nested types declared in the Backup message type.

Backup specific statistics.

Resource name for the Backup resource.

A backup schedule for a Cloud Firestore Database.

This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.

Resource name for the BackupSchedule resource.

Resource name for the CollectionGroup resource.

The request for [FirestoreAdmin.CreateBackupSchedule][google.firestore.admin.v1.FirestoreAdmin.CreateBackupSchedule].

Metadata related to the create database operation.

The request for [FirestoreAdmin.CreateDatabase][google.firestore.admin.v1.FirestoreAdmin.CreateDatabase].

The request for [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].

Represent a recurring schedule that runs at a specific time every day.

The time zone is UTC.

A Cloud Firestore Database.

Container for nested types declared in the Database message type.

Resource name for the Database resource.

The request for [FirestoreAdmin.DeleteBackup][google.firestore.admin.v1.FirestoreAdmin.DeleteBackup].

The request for [FirestoreAdmin.DeleteBackupSchedules][].

Metadata related to the delete database operation.

The request for [FirestoreAdmin.DeleteDatabase][google.firestore.admin.v1.FirestoreAdmin.DeleteDatabase].

The request for [FirestoreAdmin.DeleteIndex][google.firestore.admin.v1.FirestoreAdmin.DeleteIndex].

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

The request for [FirestoreAdmin.ExportDocuments][google.firestore.admin.v1.FirestoreAdmin.ExportDocuments].

Returned in the [google.longrunning.Operation][google.longrunning.Operation] response field.

Represents a single field in the database.

Fields are grouped by their "Collection Group", which represent all collections in the database with the same id.

Container for nested types declared in the Field message type.

The index configuration for this field.

The TTL (time-to-live) configuration for documents that have this Field set. Storing a timestamp value into a TTL-enabled field will be treated as the document's absolute expiration time. Using any other data type or leaving the field absent will disable the TTL for the individual document.

Container for nested types declared in the TtlConfig message type.

Resource name for the Field resource.

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].

Container for nested types declared in the FieldOperationMetadata message type.

Information about an index configuration change.

Container for nested types declared in the IndexConfigDelta message type.

Information about a TTL configuration change.

Container for nested types declared in the TtlConfigDelta message type.

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.

Base class for server-side implementations of FirestoreAdmin

Client for FirestoreAdmin

FirestoreAdmin client wrapper, for convenient use.

Builder class for FirestoreAdminClient to provide simple configuration of credentials, endpoint etc.

FirestoreAdmin client wrapper implementation, for convenient use.

Settings for FirestoreAdminClient instances.

The request for [FirestoreAdmin.GetBackup][google.firestore.admin.v1.FirestoreAdmin.GetBackup].

The request for [FirestoreAdmin.GetBackupSchedule][google.firestore.admin.v1.FirestoreAdmin.GetBackupSchedule].

The request for [FirestoreAdmin.GetDatabase][google.firestore.admin.v1.FirestoreAdmin.GetDatabase].

The request for [FirestoreAdmin.GetField][google.firestore.admin.v1.FirestoreAdmin.GetField].

The request for [FirestoreAdmin.GetIndex][google.firestore.admin.v1.FirestoreAdmin.GetIndex].

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].

The request for [FirestoreAdmin.ImportDocuments][google.firestore.admin.v1.FirestoreAdmin.ImportDocuments].

Cloud Firestore indexes enable simple and complex queries against documents in a database.

Container for nested types declared in the Index message type.

A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.

Container for nested types declared in the IndexField message type.

Resource name for the Index resource.

Metadata for [google.longrunning.Operation][google.longrunning.Operation] results from [FirestoreAdmin.CreateIndex][google.firestore.admin.v1.FirestoreAdmin.CreateIndex].

The request for [FirestoreAdmin.ListBackupSchedules][google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules].

The response for [FirestoreAdmin.ListBackupSchedules][google.firestore.admin.v1.FirestoreAdmin.ListBackupSchedules].

The request for [FirestoreAdmin.ListBackups][google.firestore.admin.v1.FirestoreAdmin.ListBackups].

The response for [FirestoreAdmin.ListBackups][google.firestore.admin.v1.FirestoreAdmin.ListBackups].

A request to list the Firestore Databases in all locations for a project.

The list of databases for a project.

The request for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].

The response for [FirestoreAdmin.ListFields][google.firestore.admin.v1.FirestoreAdmin.ListFields].

The request for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].

The response for [FirestoreAdmin.ListIndexes][google.firestore.admin.v1.FirestoreAdmin.ListIndexes].

The metadata message for [google.cloud.location.Location.metadata][google.cloud.location.Location.metadata].

Resource name for the Location resource.

Describes the progress of the operation. Unit of work is generic and must be interpreted based on where [Progress][google.firestore.admin.v1.Progress] is used.

Metadata for the [long-running operation][google.longrunning.Operation] from the [RestoreDatabase][google.firestore.admin.v1.RestoreDatabase] request.

The request message for [FirestoreAdmin.RestoreDatabase][google.firestore.admin.v1.RestoreDatabase].

The request for [FirestoreAdmin.UpdateBackupSchedule][google.firestore.admin.v1.FirestoreAdmin.UpdateBackupSchedule].

Metadata related to the update database operation.

The request for [FirestoreAdmin.UpdateDatabase][google.firestore.admin.v1.FirestoreAdmin.UpdateDatabase].

The request for [FirestoreAdmin.UpdateField][google.firestore.admin.v1.FirestoreAdmin.UpdateField].

Represents a recurring schedule that runs on a specified day of the week.

The time zone is UTC.

Indicate the current state of the backup.

The possible contents of BackupName.

Enum of possible cases for the "recurrence" oneof.

The possible contents of BackupScheduleName.

The possible contents of CollectionGroupName.

The type of App Engine integration mode.

The type of concurrency control mode for transactions.

The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.

Mode changes are only allowed if the database is empty.

The delete protection state of the database.

Point In Time Recovery feature enablement.

The possible contents of DatabaseName.

The state of applying the TTL configuration to all documents.

The possible contents of FieldName.

Specifies how the index is changing.

Specifies how the TTL config is changing.

API Scope defines the APIs (Firestore Native, or Firestore in Datastore Mode) that are supported for queries.

The supported array value configurations.

The supported orderings.

Enum of possible cases for the "value_mode" oneof.

Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from field.

The state of an index. During index creation, an index will be in the CREATING state. If the index is created successfully, it will transition to the READY state. If the index creation encounters a problem, the index will transition to the NEEDS_REPAIR state.

The possible contents of IndexName.

The possible contents of LocationName.

Describes the state of the operation.