Package com.google.firestore.admin.v1 (3.30.6)
This package is not the recommended entry point to using this client library!
For this library, we recommend using com.google.cloud.firestore for new applications.
Classes
Class | Description |
---|---|
com.google.firestore.admin.v1.Backup | A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given |
com.google.firestore.admin.v1.Backup.Builder | A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given |
com.google.firestore.admin.v1.Backup.Stats | Backup specific statistics. |
com.google.firestore.admin.v1.Backup.Stats.Builder | Backup specific statistics. |
com.google.firestore.admin.v1.BackupName | |
com.google.firestore.admin.v1.BackupName.Builder | Builder for projects/{project}/locations/{location}/backups/{backup}. |
com.google.firestore.admin.v1.BackupProto | |
com.google.firestore.admin.v1.BackupSchedule | A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along |
com.google.firestore.admin.v1.BackupSchedule.Builder | A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along |
com.google.firestore.admin.v1.BackupScheduleName | |
com.google.firestore.admin.v1.BackupScheduleName.Builder | Builder for projects/{project}/databases/{database}/backupSchedules/{backup_schedule}. |
com.google.firestore.admin.v1.BulkDeleteDocumentsMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments. |
com.google.firestore.admin.v1.BulkDeleteDocumentsMetadata.Builder | Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments. |
com.google.firestore.admin.v1.BulkDeleteDocumentsRequest | The request for FirestoreAdmin.BulkDeleteDocuments. |
com.google.firestore.admin.v1.BulkDeleteDocumentsRequest.Builder | The request for FirestoreAdmin.BulkDeleteDocuments. |
com.google.firestore.admin.v1.BulkDeleteDocumentsResponse | The response for FirestoreAdmin.BulkDeleteDocuments. |
com.google.firestore.admin.v1.BulkDeleteDocumentsResponse.Builder | The response for FirestoreAdmin.BulkDeleteDocuments. |
com.google.firestore.admin.v1.CollectionGroupName | |
com.google.firestore.admin.v1.CollectionGroupName.Builder | Builder for projects/{project}/databases/{database}/collectionGroups/{collection}. |
com.google.firestore.admin.v1.CreateBackupScheduleRequest | The request for FirestoreAdmin.CreateBackupSchedule. |
com.google.firestore.admin.v1.CreateBackupScheduleRequest.Builder | The request for FirestoreAdmin.CreateBackupSchedule. |
com.google.firestore.admin.v1.CreateDatabaseMetadata | Metadata related to the create database operation. |
com.google.firestore.admin.v1.CreateDatabaseMetadata.Builder | Metadata related to the create database operation. |
com.google.firestore.admin.v1.CreateDatabaseRequest | The request for FirestoreAdmin.CreateDatabase. |
com.google.firestore.admin.v1.CreateDatabaseRequest.Builder | The request for FirestoreAdmin.CreateDatabase. |
com.google.firestore.admin.v1.CreateIndexRequest | The request for FirestoreAdmin.CreateIndex. |
com.google.firestore.admin.v1.CreateIndexRequest.Builder | The request for FirestoreAdmin.CreateIndex. |
com.google.firestore.admin.v1.DailyRecurrence | Represents a recurring schedule that runs every day. The time zone is UTC. |
com.google.firestore.admin.v1.DailyRecurrence.Builder | Represents a recurring schedule that runs every day. The time zone is UTC. |
com.google.firestore.admin.v1.Database | A Cloud Firestore Database. |
com.google.firestore.admin.v1.Database.Builder | A Cloud Firestore Database. |
com.google.firestore.admin.v1.Database.CmekConfig | The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. |
com.google.firestore.admin.v1.Database.CmekConfig.Builder | The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key. |
com.google.firestore.admin.v1.Database.EncryptionConfig | Encryption configuration for a new database being created from another source. |
com.google.firestore.admin.v1.Database.EncryptionConfig.Builder | Encryption configuration for a new database being created from another source. |
com.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions | The configuration options for using CMEK (Customer Managed Encryption Key) encryption. |
com.google.firestore.admin.v1.Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder | The configuration options for using CMEK (Customer Managed Encryption Key) encryption. |
com.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions | The configuration options for using Google default encryption. |
com.google.firestore.admin.v1.Database.EncryptionConfig.GoogleDefaultEncryptionOptions.Builder | The configuration options for using Google default encryption. |
com.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions | The configuration options for using the same encryption method as the source. |
com.google.firestore.admin.v1.Database.EncryptionConfig.SourceEncryptionOptions.Builder | The configuration options for using the same encryption method as the source. |
com.google.firestore.admin.v1.Database.SourceInfo | Information about the provenance of this database. |
com.google.firestore.admin.v1.Database.SourceInfo.BackupSource | Information about a backup that was used to restore a database. |
com.google.firestore.admin.v1.Database.SourceInfo.BackupSource.Builder | Information about a backup that was used to restore a database. |
com.google.firestore.admin.v1.Database.SourceInfo.Builder | Information about the provenance of this database. |
com.google.firestore.admin.v1.DatabaseName | |
com.google.firestore.admin.v1.DatabaseName.Builder | Builder for projects/{project}/databases/{database}. |
com.google.firestore.admin.v1.DatabaseProto | |
com.google.firestore.admin.v1.DeleteBackupRequest | The request for FirestoreAdmin.DeleteBackup. |
com.google.firestore.admin.v1.DeleteBackupRequest.Builder | The request for FirestoreAdmin.DeleteBackup. |
com.google.firestore.admin.v1.DeleteBackupScheduleRequest | The request for [FirestoreAdmin.DeleteBackupSchedules][]. |
com.google.firestore.admin.v1.DeleteBackupScheduleRequest.Builder | The request for [FirestoreAdmin.DeleteBackupSchedules][]. |
com.google.firestore.admin.v1.DeleteDatabaseMetadata | Metadata related to the delete database operation. |
com.google.firestore.admin.v1.DeleteDatabaseMetadata.Builder | Metadata related to the delete database operation. |
com.google.firestore.admin.v1.DeleteDatabaseRequest | The request for FirestoreAdmin.DeleteDatabase. |
com.google.firestore.admin.v1.DeleteDatabaseRequest.Builder | The request for FirestoreAdmin.DeleteDatabase. |
com.google.firestore.admin.v1.DeleteIndexRequest | The request for FirestoreAdmin.DeleteIndex. |
com.google.firestore.admin.v1.DeleteIndexRequest.Builder | The request for FirestoreAdmin.DeleteIndex. |
com.google.firestore.admin.v1.ExportDocumentsMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments. |
com.google.firestore.admin.v1.ExportDocumentsMetadata.Builder | Metadata for google.longrunning.Operation results from FirestoreAdmin.ExportDocuments. |
com.google.firestore.admin.v1.ExportDocumentsRequest | The request for FirestoreAdmin.ExportDocuments. |
com.google.firestore.admin.v1.ExportDocumentsRequest.Builder | The request for FirestoreAdmin.ExportDocuments. |
com.google.firestore.admin.v1.ExportDocumentsResponse | Returned in the google.longrunning.Operation response field. |
com.google.firestore.admin.v1.ExportDocumentsResponse.Builder | Returned in the google.longrunning.Operation response field. |
com.google.firestore.admin.v1.Field | Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all |
com.google.firestore.admin.v1.Field.Builder | Represents a single field in the database. Fields are grouped by their "Collection Group", which represent all |
com.google.firestore.admin.v1.Field.IndexConfig | The index configuration for this field. |
com.google.firestore.admin.v1.Field.IndexConfig.Builder | The index configuration for this field. |
com.google.firestore.admin.v1.Field.TtlConfig |
The TTL (time-to-live) configuration for documents that have this Field
set.
|
com.google.firestore.admin.v1.Field.TtlConfig.Builder |
The TTL (time-to-live) configuration for documents that have this Field
set.
|
com.google.firestore.admin.v1.FieldName | |
com.google.firestore.admin.v1.FieldName.Builder | Builder for projects/{project}/databases/{database}/collectionGroups/{collection}/fields/{field}. |
com.google.firestore.admin.v1.FieldOperationMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField. |
com.google.firestore.admin.v1.FieldOperationMetadata.Builder | Metadata for google.longrunning.Operation results from FirestoreAdmin.UpdateField. |
com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta | Information about an index configuration change. |
com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.Builder | Information about an index configuration change. |
com.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta | Information about a TTL configuration change. |
com.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.Builder | Information about a TTL configuration change. |
com.google.firestore.admin.v1.FieldProto | |
com.google.firestore.admin.v1.FirestoreAdminGrpc | The Cloud Firestore Admin API. This API provides several administrative services for Cloud Firestore. Project, Database, Namespace, Collection, Collection Group, and Document are |
com.google.firestore.admin.v1.FirestoreAdminGrpc.FirestoreAdminImplBase | Base class for the server implementation of the service FirestoreAdmin. The Cloud Firestore Admin API. |
com.google.firestore.admin.v1.FirestoreAdminProto | |
com.google.firestore.admin.v1.GetBackupRequest | The request for FirestoreAdmin.GetBackup. |
com.google.firestore.admin.v1.GetBackupRequest.Builder | The request for FirestoreAdmin.GetBackup. |
com.google.firestore.admin.v1.GetBackupScheduleRequest | The request for FirestoreAdmin.GetBackupSchedule. |
com.google.firestore.admin.v1.GetBackupScheduleRequest.Builder | The request for FirestoreAdmin.GetBackupSchedule. |
com.google.firestore.admin.v1.GetDatabaseRequest | The request for FirestoreAdmin.GetDatabase. |
com.google.firestore.admin.v1.GetDatabaseRequest.Builder | The request for FirestoreAdmin.GetDatabase. |
com.google.firestore.admin.v1.GetFieldRequest | The request for FirestoreAdmin.GetField. |
com.google.firestore.admin.v1.GetFieldRequest.Builder | The request for FirestoreAdmin.GetField. |
com.google.firestore.admin.v1.GetIndexRequest | The request for FirestoreAdmin.GetIndex. |
com.google.firestore.admin.v1.GetIndexRequest.Builder | The request for FirestoreAdmin.GetIndex. |
com.google.firestore.admin.v1.ImportDocumentsMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. |
com.google.firestore.admin.v1.ImportDocumentsMetadata.Builder | Metadata for google.longrunning.Operation results from FirestoreAdmin.ImportDocuments. |
com.google.firestore.admin.v1.ImportDocumentsRequest | The request for FirestoreAdmin.ImportDocuments. |
com.google.firestore.admin.v1.ImportDocumentsRequest.Builder | The request for FirestoreAdmin.ImportDocuments. |
com.google.firestore.admin.v1.Index | Cloud Firestore indexes enable simple and complex queries against documents in a database. |
com.google.firestore.admin.v1.Index.Builder | Cloud Firestore indexes enable simple and complex queries against documents in a database. |
com.google.firestore.admin.v1.Index.IndexField | A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. |
com.google.firestore.admin.v1.Index.IndexField.Builder | A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. |
com.google.firestore.admin.v1.Index.IndexField.VectorConfig | The index configuration to support vector search operations |
com.google.firestore.admin.v1.Index.IndexField.VectorConfig.Builder | The index configuration to support vector search operations |
com.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex | An index that stores vectors in a flat data structure, and supports exhaustive search. |
com.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndex.Builder | An index that stores vectors in a flat data structure, and supports exhaustive search. |
com.google.firestore.admin.v1.IndexName | |
com.google.firestore.admin.v1.IndexName.Builder | Builder for projects/{project}/databases/{database}/collectionGroups/{collection}/indexes/{index}. |
com.google.firestore.admin.v1.IndexOperationMetadata | Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. |
com.google.firestore.admin.v1.IndexOperationMetadata.Builder | Metadata for google.longrunning.Operation results from FirestoreAdmin.CreateIndex. |
com.google.firestore.admin.v1.IndexProto | |
com.google.firestore.admin.v1.ListBackupSchedulesRequest | The request for FirestoreAdmin.ListBackupSchedules. |
com.google.firestore.admin.v1.ListBackupSchedulesRequest.Builder | The request for FirestoreAdmin.ListBackupSchedules. |
com.google.firestore.admin.v1.ListBackupSchedulesResponse | The response for FirestoreAdmin.ListBackupSchedules. |
com.google.firestore.admin.v1.ListBackupSchedulesResponse.Builder | The response for FirestoreAdmin.ListBackupSchedules. |
com.google.firestore.admin.v1.ListBackupsRequest | The request for FirestoreAdmin.ListBackups. |
com.google.firestore.admin.v1.ListBackupsRequest.Builder | The request for FirestoreAdmin.ListBackups. |
com.google.firestore.admin.v1.ListBackupsResponse | The response for FirestoreAdmin.ListBackups. |
com.google.firestore.admin.v1.ListBackupsResponse.Builder | The response for FirestoreAdmin.ListBackups. |
com.google.firestore.admin.v1.ListDatabasesRequest | A request to list the Firestore Databases in all locations for a project. |
com.google.firestore.admin.v1.ListDatabasesRequest.Builder | A request to list the Firestore Databases in all locations for a project. |
com.google.firestore.admin.v1.ListDatabasesResponse | The list of databases for a project. |
com.google.firestore.admin.v1.ListDatabasesResponse.Builder | The list of databases for a project. |
com.google.firestore.admin.v1.ListFieldsRequest | The request for FirestoreAdmin.ListFields. |
com.google.firestore.admin.v1.ListFieldsRequest.Builder | The request for FirestoreAdmin.ListFields. |
com.google.firestore.admin.v1.ListFieldsResponse | The response for FirestoreAdmin.ListFields. |
com.google.firestore.admin.v1.ListFieldsResponse.Builder | The response for FirestoreAdmin.ListFields. |
com.google.firestore.admin.v1.ListIndexesRequest | The request for FirestoreAdmin.ListIndexes. |
com.google.firestore.admin.v1.ListIndexesRequest.Builder | The request for FirestoreAdmin.ListIndexes. |
com.google.firestore.admin.v1.ListIndexesResponse | The response for FirestoreAdmin.ListIndexes. |
com.google.firestore.admin.v1.ListIndexesResponse.Builder | The response for FirestoreAdmin.ListIndexes. |
com.google.firestore.admin.v1.LocationMetadata | The metadata message for google.cloud.location.Location.metadata. |
com.google.firestore.admin.v1.LocationMetadata.Builder | The metadata message for google.cloud.location.Location.metadata. |
com.google.firestore.admin.v1.LocationName | |
com.google.firestore.admin.v1.LocationName.Builder | Builder for projects/{project}/locations/{location}. |
com.google.firestore.admin.v1.LocationProto | |
com.google.firestore.admin.v1.OperationProto | |
com.google.firestore.admin.v1.ParentName | AUTO-GENERATED DOCUMENTATION AND CLASS |
com.google.firestore.admin.v1.ParentName.Builder | Builder for ParentName. |
com.google.firestore.admin.v1.Progress | Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used. |
com.google.firestore.admin.v1.Progress.Builder | Describes the progress of the operation. Unit of work is generic and must be interpreted based on where Progress is used. |
com.google.firestore.admin.v1.ProjectName | |
com.google.firestore.admin.v1.ProjectName.Builder | Builder for projects/{project}. |
com.google.firestore.admin.v1.RestoreDatabaseMetadata | Metadata for the long-running operation from the RestoreDatabase request. |
com.google.firestore.admin.v1.RestoreDatabaseMetadata.Builder | Metadata for the long-running operation from the RestoreDatabase request. |
com.google.firestore.admin.v1.RestoreDatabaseRequest | The request message for FirestoreAdmin.RestoreDatabase. |
com.google.firestore.admin.v1.RestoreDatabaseRequest.Builder | The request message for FirestoreAdmin.RestoreDatabase. |
com.google.firestore.admin.v1.ScheduleProto | |
com.google.firestore.admin.v1.UpdateBackupScheduleRequest | The request for FirestoreAdmin.UpdateBackupSchedule. |
com.google.firestore.admin.v1.UpdateBackupScheduleRequest.Builder | The request for FirestoreAdmin.UpdateBackupSchedule. |
com.google.firestore.admin.v1.UpdateDatabaseMetadata | Metadata related to the update database operation. |
com.google.firestore.admin.v1.UpdateDatabaseMetadata.Builder | Metadata related to the update database operation. |
com.google.firestore.admin.v1.UpdateDatabaseRequest | The request for FirestoreAdmin.UpdateDatabase. |
com.google.firestore.admin.v1.UpdateDatabaseRequest.Builder | The request for FirestoreAdmin.UpdateDatabase. |
com.google.firestore.admin.v1.UpdateFieldRequest | The request for FirestoreAdmin.UpdateField. |
com.google.firestore.admin.v1.UpdateFieldRequest.Builder | The request for FirestoreAdmin.UpdateField. |
com.google.firestore.admin.v1.WeeklyRecurrence | Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. |
com.google.firestore.admin.v1.WeeklyRecurrence.Builder | Represents a recurring schedule that runs on a specified day of the week. The time zone is UTC. |