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
AggregateQuery
AggregateQuerySnapshot
BasePath
Blob
BulkWriter
BulkWriterOptions
BulkWriterOptions.Builder
CollectionGroup
CollectionReference
DocumentChange
DocumentReference
DocumentSnapshot
FieldMask
FieldPath
FieldValue
Filter
FirestoreBundle
FirestoreBundle.Builder
FirestoreOptions
FirestoreOptions.Builder
FirestoreOptions.DefaultFirestoreFactory
FirestoreOptions.DefaultFirestoreRpcFactory
FirestoreOptions.EmulatorCredentials
GeoPoint
Internal
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
StandardComparator
Enums
LLRBNode.Color
com.google.cloud.firestore.spi.v1
Package summary
Interfaces
FirestoreRpc
Classes
GrpcFirestoreRpc
com.google.cloud.firestore.v1
Package summary
Classes
FirestoreAdminClient
FirestoreAdminClient.ListFieldsFixedSizeCollection
FirestoreAdminClient.ListFieldsPage
FirestoreAdminClient.ListFieldsPagedResponse
FirestoreAdminClient.ListIndexesFixedSizeCollection
FirestoreAdminClient.ListIndexesPage
FirestoreAdminClient.ListIndexesPagedResponse
FirestoreAdminSettings
FirestoreAdminSettings.Builder
FirestoreClient
FirestoreClient.ListCollectionIdsFixedSizeCollection
FirestoreClient.ListCollectionIdsPage
FirestoreClient.ListCollectionIdsPagedResponse
FirestoreClient.ListDocumentsFixedSizeCollection
FirestoreClient.ListDocumentsPage
FirestoreClient.ListDocumentsPagedResponse
FirestoreClient.PartitionQueryFixedSizeCollection
FirestoreClient.PartitionQueryPage
FirestoreClient.PartitionQueryPagedResponse
FirestoreSettings
FirestoreSettings.Builder
com.google.cloud.firestore.v1.stub
Package summary
Classes
FirestoreAdminStub
FirestoreAdminStubSettings
FirestoreAdminStubSettings.Builder
FirestoreStub
FirestoreStubSettings
FirestoreStubSettings.Builder
GrpcFirestoreAdminCallableFactory
GrpcFirestoreAdminStub
GrpcFirestoreCallableFactory
GrpcFirestoreStub
HttpJsonFirestoreAdminCallableFactory
HttpJsonFirestoreAdminStub
HttpJsonFirestoreCallableFactory
HttpJsonFirestoreStub
com.google.firestore.admin.v1
Package summary
Interfaces
CreateIndexRequestOrBuilder
DatabaseOrBuilder
DeleteIndexRequestOrBuilder
ExportDocumentsMetadataOrBuilder
ExportDocumentsRequestOrBuilder
ExportDocumentsResponseOrBuilder
Field.IndexConfigOrBuilder
Field.TtlConfigOrBuilder
FieldOperationMetadata.IndexConfigDeltaOrBuilder
FieldOperationMetadata.TtlConfigDeltaOrBuilder
FieldOperationMetadataOrBuilder
FieldOrBuilder
FirestoreAdminGrpc.AsyncService
GetDatabaseRequestOrBuilder
GetFieldRequestOrBuilder
GetIndexRequestOrBuilder
ImportDocumentsMetadataOrBuilder
ImportDocumentsRequestOrBuilder
Index.IndexFieldOrBuilder
IndexOperationMetadataOrBuilder
IndexOrBuilder
ListDatabasesRequestOrBuilder
ListDatabasesResponseOrBuilder
ListFieldsRequestOrBuilder
ListFieldsResponseOrBuilder
ListIndexesRequestOrBuilder
ListIndexesResponseOrBuilder
LocationMetadataOrBuilder
ProgressOrBuilder
UpdateDatabaseMetadataOrBuilder
UpdateDatabaseRequestOrBuilder
UpdateFieldRequestOrBuilder
Classes
CollectionGroupName
CollectionGroupName.Builder
CreateIndexRequest
CreateIndexRequest.Builder
Database
Database.Builder
DatabaseName
DatabaseName.Builder
DatabaseProto
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
GetDatabaseRequest
GetDatabaseRequest.Builder
GetFieldRequest
GetFieldRequest.Builder
GetIndexRequest
GetIndexRequest.Builder
ImportDocumentsMetadata
ImportDocumentsMetadata.Builder
ImportDocumentsRequest
ImportDocumentsRequest.Builder
Index
Index.Builder
Index.IndexField
Index.IndexField.Builder
IndexName
IndexName.Builder
IndexOperationMetadata
IndexOperationMetadata.Builder
IndexProto
ListDatabasesRequest
ListDatabasesRequest.Builder
ListDatabasesResponse
ListDatabasesResponse.Builder
ListFieldsRequest
ListFieldsRequest.Builder
ListFieldsResponse
ListFieldsResponse.Builder
ListIndexesRequest
ListIndexesRequest.Builder
ListIndexesResponse
ListIndexesResponse.Builder
LocationMetadata
LocationMetadata.Builder
LocationProto
OperationProto
ParentName
ParentName.Builder
Progress
Progress.Builder
ProjectName
ProjectName.Builder
UpdateDatabaseMetadata
UpdateDatabaseMetadata.Builder
UpdateDatabaseRequest
UpdateDatabaseRequest.Builder
UpdateFieldRequest
UpdateFieldRequest.Builder
Enums
Database.AppEngineIntegrationMode
Database.ConcurrencyMode
Database.DatabaseType
Field.TtlConfig.State
FieldOperationMetadata.IndexConfigDelta.ChangeType
FieldOperationMetadata.TtlConfigDelta.ChangeType
Index.ApiScope
Index.IndexField.ArrayConfig
Index.IndexField.Order
Index.IndexField.ValueModeCase
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
BeginTransactionResponseOrBuilder
BitSequenceOrBuilder
BloomFilterOrBuilder
CommitRequestOrBuilder
CommitResponseOrBuilder
CreateDocumentRequestOrBuilder
CursorOrBuilder
DeleteDocumentRequestOrBuilder
DocumentChangeOrBuilder
DocumentDeleteOrBuilder
DocumentMaskOrBuilder
DocumentOrBuilder
DocumentRemoveOrBuilder
DocumentTransform.FieldTransformOrBuilder
DocumentTransformOrBuilder
ExistenceFilterOrBuilder
FirestoreGrpc.AsyncService
GetDocumentRequestOrBuilder
ListCollectionIdsRequestOrBuilder
ListCollectionIdsResponseOrBuilder
ListDocumentsRequestOrBuilder
ListDocumentsResponseOrBuilder
ListenRequestOrBuilder
ListenResponseOrBuilder
MapValueOrBuilder
PartitionQueryRequestOrBuilder
PartitionQueryResponseOrBuilder
PreconditionOrBuilder
RollbackRequestOrBuilder
RunAggregationQueryRequestOrBuilder
RunAggregationQueryResponseOrBuilder
RunQueryRequestOrBuilder
RunQueryResponseOrBuilder
StructuredAggregationQuery.Aggregation.CountOrBuilder
StructuredAggregationQuery.AggregationOrBuilder
StructuredAggregationQueryOrBuilder
StructuredQuery.CollectionSelectorOrBuilder
StructuredQuery.CompositeFilterOrBuilder
StructuredQuery.FieldFilterOrBuilder
StructuredQuery.FieldReferenceOrBuilder
StructuredQuery.FilterOrBuilder
StructuredQuery.OrderOrBuilder
StructuredQuery.ProjectionOrBuilder
StructuredQuery.UnaryFilterOrBuilder
StructuredQueryOrBuilder
Target.DocumentsTargetOrBuilder
Target.QueryTargetOrBuilder
TargetChangeOrBuilder
TargetOrBuilder
TransactionOptions.ReadOnlyOrBuilder
TransactionOptions.ReadWriteOrBuilder
TransactionOptionsOrBuilder
UpdateDocumentRequestOrBuilder
ValueOrBuilder
WriteOrBuilder
WriteRequestOrBuilder
WriteResponseOrBuilder
WriteResultOrBuilder
Classes
AggregationResult
AggregationResult.Builder
AggregationResultProto
AnyPathName
AnyPathName.Builder
ArrayValue
ArrayValue.Builder
BatchGetDocumentsRequest
BatchGetDocumentsRequest.Builder
BatchGetDocumentsResponse
BatchGetDocumentsResponse.Builder
BatchWriteRequest
BatchWriteRequest.Builder
BatchWriteResponse
BatchWriteResponse.Builder
BeginTransactionRequest
BeginTransactionRequest.Builder
BeginTransactionResponse
BeginTransactionResponse.Builder
BitSequence
BitSequence.Builder
BloomFilter
BloomFilter.Builder
BloomFilterProto
CommitRequest
CommitRequest.Builder
CommitResponse
CommitResponse.Builder
CommonProto
CreateDocumentRequest
CreateDocumentRequest.Builder
Cursor
Cursor.Builder
DatabaseRootName
DatabaseRootName.Builder
DeleteDocumentRequest
DeleteDocumentRequest.Builder
Document
Document.Builder
DocumentChange
DocumentChange.Builder
DocumentDelete
DocumentDelete.Builder
DocumentMask
DocumentMask.Builder
DocumentPathName
DocumentPathName.Builder
DocumentProto
DocumentRemove
DocumentRemove.Builder
DocumentRootName
DocumentRootName.Builder
DocumentTransform
DocumentTransform.Builder
DocumentTransform.FieldTransform
DocumentTransform.FieldTransform.Builder
ExistenceFilter
ExistenceFilter.Builder
FirestoreGrpc
FirestoreGrpc.FirestoreBlockingStub
FirestoreGrpc.FirestoreFutureStub
FirestoreGrpc.FirestoreImplBase
FirestoreGrpc.FirestoreStub
FirestoreProto
GetDocumentRequest
GetDocumentRequest.Builder
ListCollectionIdsRequest
ListCollectionIdsRequest.Builder
ListCollectionIdsResponse
ListCollectionIdsResponse.Builder
ListDocumentsRequest
ListDocumentsRequest.Builder
ListDocumentsResponse
ListDocumentsResponse.Builder
ListenRequest
ListenRequest.Builder
ListenResponse
ListenResponse.Builder
MapValue
MapValue.Builder
PartitionQueryRequest
PartitionQueryRequest.Builder
PartitionQueryResponse
PartitionQueryResponse.Builder
Precondition
Precondition.Builder
QueryProto
RollbackRequest
RollbackRequest.Builder
RunAggregationQueryRequest
RunAggregationQueryRequest.Builder
RunAggregationQueryResponse
RunAggregationQueryResponse.Builder
RunQueryRequest
RunQueryRequest.Builder
RunQueryResponse
RunQueryResponse.Builder
StructuredAggregationQuery
StructuredAggregationQuery.Aggregation
StructuredAggregationQuery.Aggregation.Builder
StructuredAggregationQuery.Aggregation.Count
StructuredAggregationQuery.Aggregation.Count.Builder
StructuredAggregationQuery.Builder
StructuredQuery
StructuredQuery.Builder
StructuredQuery.CollectionSelector
StructuredQuery.CollectionSelector.Builder
StructuredQuery.CompositeFilter
StructuredQuery.CompositeFilter.Builder
StructuredQuery.FieldFilter
StructuredQuery.FieldFilter.Builder
StructuredQuery.FieldReference
StructuredQuery.FieldReference.Builder
StructuredQuery.Filter
StructuredQuery.Filter.Builder
StructuredQuery.Order
StructuredQuery.Order.Builder
StructuredQuery.Projection
StructuredQuery.Projection.Builder
StructuredQuery.UnaryFilter
StructuredQuery.UnaryFilter.Builder
Target
Target.Builder
Target.DocumentsTarget
Target.DocumentsTarget.Builder
Target.QueryTarget
Target.QueryTarget.Builder
TargetChange
TargetChange.Builder
TransactionOptions
TransactionOptions.Builder
TransactionOptions.ReadOnly
TransactionOptions.ReadOnly.Builder
TransactionOptions.ReadWrite
TransactionOptions.ReadWrite.Builder
UpdateDocumentRequest
UpdateDocumentRequest.Builder
Value
Value.Builder
Write
Write.Builder
WriteProto
WriteRequest
WriteRequest.Builder
WriteResponse
WriteResponse.Builder
WriteResult
WriteResult.Builder
Enums
BatchGetDocumentsRequest.ConsistencySelectorCase
BatchGetDocumentsResponse.ResultCase
DocumentTransform.FieldTransform.ServerValue
DocumentTransform.FieldTransform.TransformTypeCase
GetDocumentRequest.ConsistencySelectorCase
ListCollectionIdsRequest.ConsistencySelectorCase
ListDocumentsRequest.ConsistencySelectorCase
ListenRequest.TargetChangeCase
ListenResponse.ResponseTypeCase
PartitionQueryRequest.ConsistencySelectorCase
PartitionQueryRequest.QueryTypeCase
Precondition.ConditionTypeCase
RunAggregationQueryRequest.ConsistencySelectorCase
RunAggregationQueryRequest.QueryTypeCase
RunQueryRequest.ConsistencySelectorCase
RunQueryRequest.QueryTypeCase
RunQueryResponse.ContinuationSelectorCase
StructuredAggregationQuery.Aggregation.OperatorCase
StructuredAggregationQuery.QueryTypeCase
StructuredQuery.CompositeFilter.Operator
StructuredQuery.Direction
StructuredQuery.FieldFilter.Operator
StructuredQuery.Filter.FilterTypeCase
StructuredQuery.UnaryFilter.OperandTypeCase
StructuredQuery.UnaryFilter.Operator
Target.QueryTarget.QueryTypeCase
Target.ResumeTypeCase
Target.TargetTypeCase
TargetChange.TargetChangeType
TransactionOptions.ModeCase
TransactionOptions.ReadOnly.ConsistencySelectorCase
Value.ValueTypeCase