Skip to main content
Documentation
Technology areas
close
AI and ML
Application development
Application hosting
Compute
Data analytics and pipelines
Databases
Distributed, hybrid, and multicloud
Generative AI
Industry solutions
Networking
Observability and monitoring
Security
Storage
Cross-product tools
close
Access and resources management
Costs and usage management
Google Cloud SDK, languages, frameworks, and tools
Infrastructure as code
Migration
Related sites
close
Google Cloud Home
Free Trial and Free Tier
Architecture Center
Blog
Contact Sales
Google Cloud Developer Center
Google Developer Center
Google Cloud Marketplace
Google Cloud Marketplace Documentation
Google Cloud Skills Boost
Google Cloud Solution Center
Google Cloud Support
Google Cloud Tech Youtube Channel
/
English
Deutsch
Español – América Latina
Français
Português – Brasil
中文 – 简体
日本語
한국어
Console
Sign in
Java
Overview
Guides
Reference
Samples
Contact Us
Start free
Documentation
Overview
Guides
Reference
Samples
Technology areas
More
Cross-product tools
More
Related sites
More
Console
Contact Us
Start free
Overview
Library reference docs
google-analytics-admin
google-analytics-data
google-area120-tables
google-auth-library
google-cloud-bigquerystorage
google-cloud-bigtable
google-cloud-dialogflow-cx
google-cloud-firestore
Overview
Version history
com.google.cloud.firestore
Package summary
Interfaces
BulkWriter.WriteErrorCallback
BulkWriter.WriteResultCallback
EventListener
Firestore
FirestoreFactory
FirestoreRpcFactory
ListenerRegistration
Transaction.AsyncFunction
Transaction.Function
Classes
AggregateField
AggregateField.AverageAggregateField
AggregateField.CountAggregateField
AggregateField.SumAggregateField
AggregateQuery
AggregateQuerySnapshot
BasePath
Blob
BulkWriter
BulkWriterOptions
BulkWriterOptions.Builder
CollectionGroup
CollectionReference
DocumentChange
DocumentReference
DocumentSnapshot
ExecutionStats
ExplainMetrics
ExplainOptions
ExplainOptions.Builder
ExplainResults
FieldMask
FieldPath
FieldValue
Filter
FirestoreBundle
FirestoreBundle.Builder
FirestoreOptions
FirestoreOptions.Builder
FirestoreOptions.DefaultFirestoreFactory
FirestoreOptions.DefaultFirestoreRpcFactory
FirestoreOptions.EmulatorCredentials
GeoPoint
Internal
PlanSummary
Precondition
Query
QueryDocumentSnapshot
QueryPartition
QuerySnapshot
RecursiveDelete
SetOptions
Transaction
TransactionOptions
TransactionOptions.Builder
TransactionOptions.ReadOnlyOptionsBuilder
TransactionOptions.ReadWriteOptionsBuilder
UpdateBuilder
WriteBatch
WriteResult
Enums
DocumentChange.Type
Query.Direction
TransactionOptions.TransactionOptionsType
Exceptions
BulkWriterException
FirestoreException
com.google.cloud.firestore.annotation
Package summary
Annotation Types
DocumentId
Exclude
IgnoreExtraProperties
PropertyName
ServerTimestamp
ThrowOnExtraProperties
com.google.cloud.firestore.collection
Package summary
Interfaces
ImmutableSortedMap.Builder.KeyTranslator
LLRBNode
LLRBNode.ShortCircuitingNodeVisitor
Classes
ArraySortedMap
ImmutableSortedMap
ImmutableSortedMap.Builder
ImmutableSortedMapIterator
ImmutableSortedSet
LLRBBlackValueNode
LLRBEmptyNode
LLRBNode.NodeVisitor
LLRBRedValueNode
LLRBValueNode
RBTreeSortedMap
Enums
LLRBNode.Color
com.google.cloud.firestore.spi.v1
Package summary
Interfaces
FirestoreRpc
Classes
GrpcFirestoreRpc
com.google.cloud.firestore.v1
Package summary
Clients
FirestoreAdminClient
FirestoreClient
Settings
FirestoreAdminSettings
FirestoreSettings
Requests and responses
FirestoreAdminClient.ListFieldsPagedResponse
FirestoreAdminClient.ListIndexesPagedResponse
FirestoreClient.ListCollectionIdsPagedResponse
FirestoreClient.ListDocumentsPagedResponse
FirestoreClient.PartitionQueryPagedResponse
All other classes and interfaces
Builders
FirestoreAdminSettings.Builder
FirestoreSettings.Builder
Paging
FirestoreAdminClient.ListFieldsFixedSizeCollection
FirestoreAdminClient.ListFieldsPage
FirestoreAdminClient.ListIndexesFixedSizeCollection
FirestoreAdminClient.ListIndexesPage
FirestoreClient.ListCollectionIdsFixedSizeCollection
FirestoreClient.ListCollectionIdsPage
FirestoreClient.ListDocumentsFixedSizeCollection
FirestoreClient.ListDocumentsPage
FirestoreClient.PartitionQueryFixedSizeCollection
FirestoreClient.PartitionQueryPage
Stub packages
com.google.cloud.firestore.v1.stub
Package summary
Stubs
FirestoreAdminStub
FirestoreStub
GrpcFirestoreAdminStub
GrpcFirestoreStub
HttpJsonFirestoreAdminStub
HttpJsonFirestoreStub
Settings
FirestoreAdminStubSettings
FirestoreAdminStubSettings.Builder
FirestoreStubSettings
FirestoreStubSettings.Builder
Callable factories
GrpcFirestoreAdminCallableFactory
GrpcFirestoreCallableFactory
HttpJsonFirestoreAdminCallableFactory
HttpJsonFirestoreCallableFactory
com.google.firestore.admin.v1
Package summary
Interfaces
Backup.StatsOrBuilder
BackupOrBuilder
BackupScheduleOrBuilder
BulkDeleteDocumentsMetadataOrBuilder
BulkDeleteDocumentsRequestOrBuilder
BulkDeleteDocumentsResponseOrBuilder
CreateBackupScheduleRequestOrBuilder
CreateDatabaseMetadataOrBuilder
CreateDatabaseRequestOrBuilder
CreateIndexRequestOrBuilder
DailyRecurrenceOrBuilder
DatabaseOrBuilder
DeleteBackupRequestOrBuilder
DeleteBackupScheduleRequestOrBuilder
DeleteDatabaseMetadataOrBuilder
DeleteDatabaseRequestOrBuilder
DeleteIndexRequestOrBuilder
ExportDocumentsMetadataOrBuilder
ExportDocumentsRequestOrBuilder
ExportDocumentsResponseOrBuilder
Field.IndexConfigOrBuilder
Field.TtlConfigOrBuilder
FieldOperationMetadata.IndexConfigDeltaOrBuilder
FieldOperationMetadata.TtlConfigDeltaOrBuilder
FieldOperationMetadataOrBuilder
FieldOrBuilder
FirestoreAdminGrpc.AsyncService
GetBackupRequestOrBuilder
GetBackupScheduleRequestOrBuilder
GetDatabaseRequestOrBuilder
GetFieldRequestOrBuilder
GetIndexRequestOrBuilder
ImportDocumentsMetadataOrBuilder
ImportDocumentsRequestOrBuilder
Index.IndexField.VectorConfig.FlatIndexOrBuilder
Index.IndexField.VectorConfigOrBuilder
Index.IndexFieldOrBuilder
IndexOperationMetadataOrBuilder
IndexOrBuilder
ListBackupSchedulesRequestOrBuilder
ListBackupSchedulesResponseOrBuilder
ListBackupsRequestOrBuilder
ListBackupsResponseOrBuilder
ListDatabasesRequestOrBuilder
ListDatabasesResponseOrBuilder
ListFieldsRequestOrBuilder
ListFieldsResponseOrBuilder
ListIndexesRequestOrBuilder
ListIndexesResponseOrBuilder
LocationMetadataOrBuilder
ProgressOrBuilder
RestoreDatabaseMetadataOrBuilder
RestoreDatabaseRequestOrBuilder
UpdateBackupScheduleRequestOrBuilder
UpdateDatabaseMetadataOrBuilder
UpdateDatabaseRequestOrBuilder
UpdateFieldRequestOrBuilder
WeeklyRecurrenceOrBuilder
Classes
Backup
Backup.Builder
Backup.Stats
Backup.Stats.Builder
BackupName
BackupName.Builder
BackupProto
BackupSchedule
BackupSchedule.Builder
BackupScheduleName
BackupScheduleName.Builder
BulkDeleteDocumentsMetadata
BulkDeleteDocumentsMetadata.Builder
BulkDeleteDocumentsRequest
BulkDeleteDocumentsRequest.Builder
BulkDeleteDocumentsResponse
BulkDeleteDocumentsResponse.Builder
CollectionGroupName
CollectionGroupName.Builder
CreateBackupScheduleRequest
CreateBackupScheduleRequest.Builder
CreateDatabaseMetadata
CreateDatabaseMetadata.Builder
CreateDatabaseRequest
CreateDatabaseRequest.Builder
CreateIndexRequest
CreateIndexRequest.Builder
DailyRecurrence
DailyRecurrence.Builder
Database
Database.Builder
DatabaseName
DatabaseName.Builder
DatabaseProto
DeleteBackupRequest
DeleteBackupRequest.Builder
DeleteBackupScheduleRequest
DeleteBackupScheduleRequest.Builder
DeleteDatabaseMetadata
DeleteDatabaseMetadata.Builder
DeleteDatabaseRequest
DeleteDatabaseRequest.Builder
DeleteIndexRequest
DeleteIndexRequest.Builder
ExportDocumentsMetadata
ExportDocumentsMetadata.Builder
ExportDocumentsRequest
ExportDocumentsRequest.Builder
ExportDocumentsResponse
ExportDocumentsResponse.Builder
Field
Field.Builder
Field.IndexConfig
Field.IndexConfig.Builder
Field.TtlConfig
Field.TtlConfig.Builder
FieldName
FieldName.Builder
FieldOperationMetadata
FieldOperationMetadata.Builder
FieldOperationMetadata.IndexConfigDelta
FieldOperationMetadata.IndexConfigDelta.Builder
FieldOperationMetadata.TtlConfigDelta
FieldOperationMetadata.TtlConfigDelta.Builder
FieldProto
FirestoreAdminGrpc
FirestoreAdminGrpc.FirestoreAdminBlockingStub
FirestoreAdminGrpc.FirestoreAdminFutureStub
FirestoreAdminGrpc.FirestoreAdminImplBase
FirestoreAdminGrpc.FirestoreAdminStub
FirestoreAdminProto
GetBackupRequest
GetBackupRequest.Builder
GetBackupScheduleRequest
GetBackupScheduleRequest.Builder
GetDatabaseRequest
GetDatabaseRequest.Builder
GetFieldRequest
GetFieldRequest.Builder
GetIndexRequest
GetIndexRequest.Builder
ImportDocumentsMetadata
ImportDocumentsMetadata.Builder
ImportDocumentsRequest
ImportDocumentsRequest.Builder
Index
Index.Builder
Index.IndexField
Index.IndexField.Builder
Index.IndexField.VectorConfig
Index.IndexField.VectorConfig.Builder
Index.IndexField.VectorConfig.FlatIndex
Index.IndexField.VectorConfig.FlatIndex.Builder
IndexName
IndexName.Builder
IndexOperationMetadata
IndexOperationMetadata.Builder
IndexProto
ListBackupSchedulesRequest
ListBackupSchedulesRequest.Builder
ListBackupSchedulesResponse
ListBackupSchedulesResponse.Builder
ListBackupsRequest
ListBackupsRequest.Builder
ListBackupsResponse
ListBackupsResponse.Builder
ListDatabasesRequest
ListDatabasesRequest.Builder
ListDatabasesResponse
ListDatabasesResponse.Builder
ListFieldsRequest
ListFieldsRequest.Builder
ListFieldsResponse
ListFieldsResponse.Builder
ListIndexesRequest
ListIndexesRequest.Builder
ListIndexesResponse
ListIndexesResponse.Builder
LocationMetadata
LocationMetadata.Builder
LocationName
LocationName.Builder
LocationProto
OperationProto
ParentName
ParentName.Builder
Progress
Progress.Builder
ProjectName
ProjectName.Builder
RestoreDatabaseMetadata
RestoreDatabaseMetadata.Builder
RestoreDatabaseRequest
RestoreDatabaseRequest.Builder
ScheduleProto
UpdateBackupScheduleRequest
UpdateBackupScheduleRequest.Builder
UpdateDatabaseMetadata
UpdateDatabaseMetadata.Builder
UpdateDatabaseRequest
UpdateDatabaseRequest.Builder
UpdateFieldRequest
UpdateFieldRequest.Builder
WeeklyRecurrence
WeeklyRecurrence.Builder
Enums
Backup.State
BackupSchedule.RecurrenceCase
Database.AppEngineIntegrationMode
Database.ConcurrencyMode
Database.DatabaseType
Database.DeleteProtectionState
Database.PointInTimeRecoveryEnablement
Field.TtlConfig.State
FieldOperationMetadata.IndexConfigDelta.ChangeType
FieldOperationMetadata.TtlConfigDelta.ChangeType
Index.ApiScope
Index.IndexField.ArrayConfig
Index.IndexField.Order
Index.IndexField.ValueModeCase
Index.IndexField.VectorConfig.TypeCase
Index.QueryScope
Index.State
OperationState
com.google.firestore.bundle
Package summary
Interfaces
BundleElementOrBuilder
BundleMetadataOrBuilder
BundledDocumentMetadataOrBuilder
BundledQueryOrBuilder
NamedQueryOrBuilder
Classes
BundleElement
BundleElement.Builder
BundleMetadata
BundleMetadata.Builder
BundleProto
BundledDocumentMetadata
BundledDocumentMetadata.Builder
BundledQuery
BundledQuery.Builder
NamedQuery
NamedQuery.Builder
Enums
BundleElement.ElementTypeCase
BundledQuery.LimitType
BundledQuery.QueryTypeCase
com.google.firestore.v1
Package summary
Interfaces
AggregationResultOrBuilder
ArrayValueOrBuilder
BatchGetDocumentsRequestOrBuilder
BatchGetDocumentsResponseOrBuilder
BatchWriteRequestOrBuilder
BatchWriteResponseOrBuilder
BeginTransactionRequestOrBuilder