Package com.google.firestore.admin.v1 (3.21.0)

GitHub Repository

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.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 at a specific time every day. The time zone is UTC.
com.google.firestore.admin.v1.DailyRecurrence.Builder Represents a recurring schedule that runs at a specific time 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.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. Storing a timestamp value into a TTL-enabled field will be treated as
com.google.firestore.admin.v1.Field.TtlConfig.Builder 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
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.

Interfaces

Interface Description
com.google.firestore.admin.v1.Backup.StatsOrBuilder
com.google.firestore.admin.v1.BackupOrBuilder
com.google.firestore.admin.v1.BackupScheduleOrBuilder
com.google.firestore.admin.v1.CreateBackupScheduleRequestOrBuilder
com.google.firestore.admin.v1.CreateDatabaseMetadataOrBuilder
com.google.firestore.admin.v1.CreateDatabaseRequestOrBuilder
com.google.firestore.admin.v1.CreateIndexRequestOrBuilder
com.google.firestore.admin.v1.DailyRecurrenceOrBuilder
com.google.firestore.admin.v1.DatabaseOrBuilder
com.google.firestore.admin.v1.DeleteBackupRequestOrBuilder
com.google.firestore.admin.v1.DeleteBackupScheduleRequestOrBuilder
com.google.firestore.admin.v1.DeleteDatabaseMetadataOrBuilder
com.google.firestore.admin.v1.DeleteDatabaseRequestOrBuilder
com.google.firestore.admin.v1.DeleteIndexRequestOrBuilder
com.google.firestore.admin.v1.ExportDocumentsMetadataOrBuilder
com.google.firestore.admin.v1.ExportDocumentsRequestOrBuilder
com.google.firestore.admin.v1.ExportDocumentsResponseOrBuilder
com.google.firestore.admin.v1.Field.IndexConfigOrBuilder
com.google.firestore.admin.v1.Field.TtlConfigOrBuilder
com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDeltaOrBuilder
com.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDeltaOrBuilder
com.google.firestore.admin.v1.FieldOperationMetadataOrBuilder
com.google.firestore.admin.v1.FieldOrBuilder
com.google.firestore.admin.v1.FirestoreAdminGrpc.AsyncService 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.GetBackupRequestOrBuilder
com.google.firestore.admin.v1.GetBackupScheduleRequestOrBuilder
com.google.firestore.admin.v1.GetDatabaseRequestOrBuilder
com.google.firestore.admin.v1.GetFieldRequestOrBuilder
com.google.firestore.admin.v1.GetIndexRequestOrBuilder
com.google.firestore.admin.v1.ImportDocumentsMetadataOrBuilder
com.google.firestore.admin.v1.ImportDocumentsRequestOrBuilder
com.google.firestore.admin.v1.Index.IndexField.VectorConfig.FlatIndexOrBuilder
com.google.firestore.admin.v1.Index.IndexField.VectorConfigOrBuilder
com.google.firestore.admin.v1.Index.IndexFieldOrBuilder
com.google.firestore.admin.v1.IndexOperationMetadataOrBuilder
com.google.firestore.admin.v1.IndexOrBuilder
com.google.firestore.admin.v1.ListBackupSchedulesRequestOrBuilder
com.google.firestore.admin.v1.ListBackupSchedulesResponseOrBuilder
com.google.firestore.admin.v1.ListBackupsRequestOrBuilder
com.google.firestore.admin.v1.ListBackupsResponseOrBuilder
com.google.firestore.admin.v1.ListDatabasesRequestOrBuilder
com.google.firestore.admin.v1.ListDatabasesResponseOrBuilder
com.google.firestore.admin.v1.ListFieldsRequestOrBuilder
com.google.firestore.admin.v1.ListFieldsResponseOrBuilder
com.google.firestore.admin.v1.ListIndexesRequestOrBuilder
com.google.firestore.admin.v1.ListIndexesResponseOrBuilder
com.google.firestore.admin.v1.LocationMetadataOrBuilder
com.google.firestore.admin.v1.ProgressOrBuilder
com.google.firestore.admin.v1.RestoreDatabaseMetadataOrBuilder
com.google.firestore.admin.v1.RestoreDatabaseRequestOrBuilder
com.google.firestore.admin.v1.UpdateBackupScheduleRequestOrBuilder
com.google.firestore.admin.v1.UpdateDatabaseMetadataOrBuilder
com.google.firestore.admin.v1.UpdateDatabaseRequestOrBuilder
com.google.firestore.admin.v1.UpdateFieldRequestOrBuilder
com.google.firestore.admin.v1.WeeklyRecurrenceOrBuilder

Enums

Enum Description
com.google.firestore.admin.v1.Backup.State Indicate the current state of the backup.
com.google.firestore.admin.v1.BackupSchedule.RecurrenceCase
com.google.firestore.admin.v1.Database.AppEngineIntegrationMode The type of App Engine integration mode.
com.google.firestore.admin.v1.Database.ConcurrencyMode The type of concurrency control mode for transactions.
com.google.firestore.admin.v1.Database.DatabaseType The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
com.google.firestore.admin.v1.Database.DeleteProtectionState The delete protection state of the database.
com.google.firestore.admin.v1.Database.PointInTimeRecoveryEnablement Point In Time Recovery feature enablement.
com.google.firestore.admin.v1.Field.TtlConfig.State The state of applying the TTL configuration to all documents.
com.google.firestore.admin.v1.FieldOperationMetadata.IndexConfigDelta.ChangeType Specifies how the index is changing.
com.google.firestore.admin.v1.FieldOperationMetadata.TtlConfigDelta.ChangeType Specifies how the TTL config is changing.
com.google.firestore.admin.v1.Index.ApiScope API Scope defines the APIs (Firestore Native, or Firestore in Datastore Mode) that are supported for queries.
com.google.firestore.admin.v1.Index.IndexField.ArrayConfig The supported array value configurations.
com.google.firestore.admin.v1.Index.IndexField.Order The supported orderings.
com.google.firestore.admin.v1.Index.IndexField.ValueModeCase
com.google.firestore.admin.v1.Index.IndexField.VectorConfig.TypeCase
com.google.firestore.admin.v1.Index.QueryScope Query Scope defines the scope at which a query is run. This is specified on a StructuredQuery's from field.
com.google.firestore.admin.v1.Index.State 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
com.google.firestore.admin.v1.OperationState Describes the state of the operation.