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
ad-manager
admin
alloydb-connector
api-common
gax
google-analytics-admin
google-analytics-data
google-api-client
google-area120-tables
google-auth-library
google-cloud-accessapproval
google-cloud-advisorynotifications
google-cloud-aiplatform
google-cloud-alloydb
google-cloud-alloydb-connectors
google-cloud-analyticshub
google-cloud-api-gateway
google-cloud-apigee-connect
google-cloud-apigee-registry
google-cloud-apihub
google-cloud-apikeys
google-cloud-appengine-admin
google-cloud-apphub
google-cloud-artifact-registry
google-cloud-asset
google-cloud-assured-workloads
google-cloud-automl
google-cloud-backupdr
google-cloud-bare-metal-solution
google-cloud-batch
google-cloud-beyondcorp-appconnections
google-cloud-beyondcorp-appconnectors
google-cloud-beyondcorp-appgateways
google-cloud-beyondcorp-clientconnectorservices
google-cloud-beyondcorp-clientgateways
google-cloud-biglake
google-cloud-bigquery
google-cloud-bigquery-data-exchange
google-cloud-bigqueryconnection
google-cloud-bigquerydatapolicy
google-cloud-bigquerydatatransfer
google-cloud-bigquerymigration
google-cloud-bigqueryreservation
google-cloud-bigquerystorage
google-cloud-bigtable
google-cloud-billing
google-cloud-billingbudgets
google-cloud-binary-authorization
google-cloud-build
google-cloud-certificate-manager
google-cloud-channel
google-cloud-chat
google-cloud-chronicle
google-cloud-cloudcommerceconsumerprocurement
google-cloud-cloudcontrolspartner
google-cloud-cloudquotas
google-cloud-cloudsupport
google-cloud-compute
google-cloud-confidentialcomputing
google-cloud-configdelivery
google-cloud-connectgateway
google-cloud-contact-center-insights
google-cloud-container
google-cloud-containeranalysis
google-cloud-contentwarehouse
google-cloud-core
google-cloud-data-fusion
google-cloud-datacatalog
google-cloud-dataflow
google-cloud-dataform
google-cloud-datalabeling
google-cloud-datalineage
google-cloud-dataplex
google-cloud-dataproc
google-cloud-dataproc-metastore
google-cloud-datastore
google-cloud-datastream
google-cloud-debugger-client
google-cloud-deploy
google-cloud-developerconnect
google-cloud-devicestreaming
google-cloud-dialogflow
google-cloud-dialogflow-cx
google-cloud-discoveryengine
google-cloud-distributedcloudedge
google-cloud-dlp
google-cloud-dms
google-cloud-dns
google-cloud-document-ai
google-cloud-domains
google-cloud-edgenetwork
google-cloud-enterpriseknowledgegraph
google-cloud-errorreporting
google-cloud-essential-contacts
google-cloud-eventarc
google-cloud-eventarc-publishing
google-cloud-filestore
google-cloud-financialservices
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
FirestoreOpenTelemetryOptions
FirestoreOpenTelemetryOptions.Builder
FirestoreOptions
FirestoreOptions.Builder
FirestoreOptions.DefaultFirestoreFactory
FirestoreOptions.DefaultFirestoreRpcFactory
FirestoreOptions.EmulatorCredentials
GenericQuerySnapshot
GeoPoint
Internal
PlanSummary
Precondition
Query
QueryDocumentSnapshot
QueryPartition
QuerySnapshot
RecursiveDelete
SetOptions
StreamableQuery
Transaction
TransactionOptions
TransactionOptions.Builder
TransactionOptions.ReadOnlyOptionsBuilder
TransactionOptions.ReadWriteOptionsBuilder
UpdateBuilder
VectorQuery
VectorQueryOptions
VectorQueryOptions.Builder
VectorQuerySnapshot
VectorValue
WriteBatch
WriteResult
Enums
DocumentChange.Type
Query.Direction
TransactionOptions.TransactionOptionsType
VectorQuery.DistanceMeasure
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.encoding
Package summary
Classes
CustomClassMapper
com.google.cloud.firestore.spi.v1
Package summary
Interfaces
FirestoreRpc
Classes
GrpcFirestoreRpc
com.google.cloud.firestore.telemetry
Package summary
Interfaces
MetricsUtil
MetricsUtil.MetricsContext
TelemetryConstants
TraceUtil
TraceUtil.Context
TraceUtil.Scope
TraceUtil.Span
Classes
CompositeApiTracerFactory
DisabledTraceUtil
EnabledTraceUtil
EnabledTraceUtil.OpenTelemetryGrpcChannelConfigurator
Enums
TelemetryConstants.MetricType
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
CreateUserCredsRequestOrBuilder
DailyRecurrenceOrBuilder
Database.CmekConfigOrBuilder
Database.EncryptionConfig.CustomerManagedEncryptionOptionsOrBuilder
Database.EncryptionConfig.GoogleDefaultEncryptionOptionsOrBuilder
Database.EncryptionConfig.SourceEncryptionOptionsOrBuilder
Database.EncryptionConfigOrBuilder
Database.SourceInfo.BackupSourceOrBuilder
Database.SourceInfoOrBuilder
DatabaseOrBuilder
DeleteBackupRequestOrBuilder
DeleteBackupScheduleRequestOrBuilder
DeleteDatabaseMetadataOrBuilder
DeleteDatabaseRequestOrBuilder
DeleteIndexRequestOrBuilder
DeleteUserCredsRequestOrBuilder
DisableUserCredsRequestOrBuilder
EnableUserCredsRequestOrBuilder
ExportDocumentsMetadataOrBuilder
ExportDocumentsRequestOrBuilder
ExportDocumentsResponseOrBuilder
Field.IndexConfigOrBuilder
Field.TtlConfigOrBuilder
FieldOperationMetadata.IndexConfigDeltaOrBuilder
FieldOperationMetadata.TtlConfigDeltaOrBuilder
FieldOperationMetadataOrBuilder
FieldOrBuilder
FirestoreAdminGrpc.AsyncService
GetBackupRequestOrBuilder
GetBackupScheduleRequestOrBuilder
GetDatabaseRequestOrBuilder
GetFieldRequestOrBuilder
GetIndexRequestOrBuilder
GetUserCredsRequestOrBuilder
ImportDocumentsMetadataOrBuilder
ImportDocumentsRequestOrBuilder
Index.IndexField.VectorConfig.FlatIndexOrBuilder
Index.IndexField.VectorConfigOrBuilder
Index.IndexFieldOrBuilder
IndexOperationMetadataOrBuilder
IndexOrBuilder
ListBackupSchedulesRequestOrBuilder
ListBackupSchedulesResponseOrBuilder
ListBackupsRequestOrBuilder
ListBackupsResponseOrBuilder
ListDatabasesRequestOrBuilder
ListDatabasesResponseOrBuilder
ListFieldsRequestOrBuilder
ListFieldsResponseOrBuilder
ListIndexesRequestOrBuilder
ListIndexesResponseOrBuilder
ListUserCredsRequestOrBuilder
ListUserCredsResponseOrBuilder
LocationMetadataOrBuilder
ProgressOrBuilder
ResetUserPasswordRequestOrBuilder
RestoreDatabaseMetadataOrBuilder
RestoreDatabaseRequestOrBuilder
UpdateBackupScheduleRequestOrBuilder
UpdateDatabaseMetadataOrBuilder
UpdateDatabaseRequestOrBuilder
UpdateFieldRequestOrBuilder
UserCreds.ResourceIdentityOrBuilder
UserCredsOrBuilder
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
CreateUserCredsRequest
CreateUserCredsRequest.Builder
DailyRecurrence
DailyRecurrence.Builder
Database
Database.Builder
Database.CmekConfig
Database.CmekConfig.Builder
Database.EncryptionConfig
Database.EncryptionConfig.Builder
Database.EncryptionConfig.CustomerManagedEncryptionOptions
Database.EncryptionConfig.CustomerManagedEncryptionOptions.Builder
Database.EncryptionConfig.GoogleDefaultEncryptionOptions
Database.EncryptionConfig.GoogleDefaultEncryptionOptions.Builder
Database.EncryptionConfig.SourceEncryptionOptions
Database.EncryptionConfig.SourceEncryptionOptions.Builder
Database.SourceInfo
Database.SourceInfo.BackupSource
Database.SourceInfo.BackupSource.Builder
Database.SourceInfo.Builder
DatabaseName
DatabaseName.Builder
DatabaseProto
DeleteBackupRequest
DeleteBackupRequest.Builder
DeleteBackupScheduleRequest
DeleteBackupScheduleRequest.Builder
DeleteDatabaseMetadata
DeleteDatabaseMetadata.Builder
DeleteDatabaseRequest
DeleteDatabaseRequest.Builder
DeleteIndexRequest
DeleteIndexRequest.Builder
DeleteUserCredsRequest
DeleteUserCredsRequest.Builder
DisableUserCredsRequest
DisableUserCredsRequest.Builder
EnableUserCredsRequest
EnableUserCredsRequest.Builder
ExportDocumentsMetadata
ExportDocumentsMetadata.Builder
ExportDocumentsRequest
ExportDocumentsRequest.Builder
ExportDocumentsResponse