firestore library

Classes

BackupSchedule
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. Auto-naming is currently not supported for this resource.
BackupScheduleArgs
The set of arguments for BackupSchedule. The set of arguments for BackupSchedule.
Database
Create a database.
DatabaseArgs
The set of arguments for Database. The set of arguments for Database.
GetBackupScheduleArgs
Arguments for getBackupSchedule. Arguments for getBackupSchedule.
GetBackupScheduleResult
Result data returned by getBackupSchedule.
GetDatabaseArgs
Arguments for getDatabase. Arguments for getDatabase.
GetDatabaseResult
Result data returned by getDatabase.
GetIndexArgs
Arguments for getIndex. Arguments for getIndex.
GetIndexFirestoreV1beta1Args
Arguments for getIndex. Arguments for getIndex.
GetIndexFirestoreV1beta1Result
Result data returned by getIndex.
GetIndexFirestoreV1beta2Args
Arguments for getIndex. Arguments for getIndex.
GetIndexFirestoreV1beta2Result
Result data returned by getIndex.
GetIndexResult
Result data returned by getIndex.
GoogleFirestoreAdminV1beta1IndexField
A field of an index.
GoogleFirestoreAdminV1beta1IndexFieldResponse
A field of an index.
GoogleFirestoreAdminV1beta2IndexField
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
GoogleFirestoreAdminV1beta2IndexFieldResponse
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
GoogleFirestoreAdminV1IndexField
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
GoogleFirestoreAdminV1IndexFieldResponse
A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed.
GoogleFirestoreAdminV1VectorConfig
The index configuration to support vector search operations
GoogleFirestoreAdminV1VectorConfigResponse
The index configuration to support vector search operations
GoogleFirestoreAdminV1WeeklyRecurrence
Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC.
GoogleFirestoreAdminV1WeeklyRecurrenceResponse
Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC.
Index
Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. Auto-naming is currently not supported for this resource.
IndexArgs
The set of arguments for Index. The set of arguments for Index.
IndexFirestoreV1beta1
Creates the specified index. A newly created index's initial state is CREATING. On completion of the returned google.longrunning.Operation, the state will be READY. If the index already exists, the call will return an ALREADY_EXISTS status. During creation, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.
IndexFirestoreV1beta1Args
The set of arguments for Index. The set of arguments for Index.
IndexFirestoreV1beta2
Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. Auto-naming is currently not supported for this resource.
IndexFirestoreV1beta2Args
The set of arguments for Index. The set of arguments for Index.

Enums

DatabaseAppEngineIntegrationMode
The App Engine integration mode to use for this database.
DatabaseConcurrencyMode
The concurrency control mode to use for this database.
DatabaseDeleteProtectionState
State of delete protection for the database.
DatabasePointInTimeRecoveryEnablement
Whether to enable the PITR feature on this database.
DatabaseType
The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
GoogleFirestoreAdminV1beta1IndexFieldMode
The field's mode.
GoogleFirestoreAdminV1beta2IndexFieldArrayConfig
Indicates that this field supports operations on array_values.
GoogleFirestoreAdminV1beta2IndexFieldOrder
Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
GoogleFirestoreAdminV1IndexFieldArrayConfig
Indicates that this field supports operations on array_values.
GoogleFirestoreAdminV1IndexFieldOrder
Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
GoogleFirestoreAdminV1WeeklyRecurrenceDay
The day of week to run. DAY_OF_WEEK_UNSPECIFIED is not allowed.
IndexApiScope
The API scope supported by this index.
IndexQueryScope
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
IndexQueryScopeFirestoreV1beta2
Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index.
IndexState
The state of the index. Output only.

Functions

getBackupSchedule(GetBackupScheduleArgs args, {InvokeOptions? options}) → Future<GetBackupScheduleResult>
Gets information about a backup schedule. args Arguments passed to this invoke. Arguments for getBackupSchedule. options Invoke options controlling this call.
getDatabase(GetDatabaseArgs args, {InvokeOptions? options}) → Future<GetDatabaseResult>
Gets information about a database. args Arguments passed to this invoke. Arguments for getDatabase. options Invoke options controlling this call.
getIndex(GetIndexArgs args, {InvokeOptions? options}) → Future<GetIndexResult>
Gets a composite index. args Arguments passed to this invoke. Arguments for getIndex. options Invoke options controlling this call.
getIndexFirestoreV1beta1(GetIndexFirestoreV1beta1Args args, {InvokeOptions? options}) → Future<GetIndexFirestoreV1beta1Result>
Gets an index. args Arguments passed to this invoke. Arguments for getIndex. options Invoke options controlling this call.
getIndexFirestoreV1beta2(GetIndexFirestoreV1beta2Args args, {InvokeOptions? options}) → Future<GetIndexFirestoreV1beta2Result>
Gets a composite index. args Arguments passed to this invoke. Arguments for getIndex. options Invoke options controlling this call.