Skip to main content
Google Cloud
Documentation Technology areas
  • 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
  • Access and resources management
  • Costs and usage management
  • Google Cloud SDK, languages, frameworks, and tools
  • Infrastructure as code
  • Migration
Related sites
  • 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
Google Cloud
  • 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-cloudcommerceconsumerprocurement
  • google-cloud-cloudcontrolspartner
  • google-cloud-cloudquotas
  • google-cloud-cloudsupport
  • google-cloud-compute
  • google-cloud-confidentialcomputing
  • 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-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-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
      • 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
      • 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
      • 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
      • 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.EncryptionConfig.EncryptionTypeCase
      • Database.PointInTimeRecoveryEnablement
      • Database.SourceInfo.SourceCase
      • 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
      • BeginTransactionResponseOrBuilder
      • BitSequenceOrBuilder
      • BloomFilterOrBuilder
      • CommitRequestOrBuilder
      • CommitResponseOrBuilder
      • CreateDocumentRequestOrBuilder
      • CursorOrBuilder
      • DeleteDocumentRequestOrBuilder
      • DocumentChangeOrBuilder
      • DocumentDeleteOrBuilder
      • DocumentMaskOrBuilder
      • DocumentOrBuilder
      • DocumentRemoveOrBuilder
      • DocumentTransform.FieldTransformOrBuilder
      • DocumentTransformOrBuilder
      • ExecutionStatsOrBuilder
      • ExistenceFilterOrBuilder
      • ExplainMetricsOrBuilder
      • ExplainOptionsOrBuilder
      • FirestoreGrpc.AsyncService
      • GetDocumentRequestOrBuilder
      • ListCollectionIdsRequestOrBuilder
      • ListCollectionIdsResponseOrBuilder
      • ListDocumentsRequestOrBuilder
      • ListDocumentsResponseOrBuilder
      • ListenRequestOrBuilder
      • ListenResponseOrBuilder
      • MapValueOrBuilder
      • PartitionQueryRequestOrBuilder
      • PartitionQueryResponseOrBuilder
      • PlanSummaryOrBuilder
      • PreconditionOrBuilder
      • RollbackRequestOrBuilder
      • RunAggregationQueryRequestOrBuilder
      • RunAggregationQueryResponseOrBuilder
      • RunQueryRequestOrBuilder
      • RunQueryResponseOrBuilder
      • StructuredAggregationQuery.Aggregation.AvgOrBuilder
      • StructuredAggregationQuery.Aggregation.CountOrBuilder
      • StructuredAggregationQuery.Aggregation.SumOrBuilder
      • StructuredAggregationQuery.AggregationOrBuilder
      • StructuredAggregationQueryOrBuilder
      • StructuredQuery.CollectionSelectorOrBuilder
      • StructuredQuery.CompositeFilterOrBuilder
      • StructuredQuery.FieldFilterOrBuilder
      • StructuredQuery.FieldReferenceOrBuilder
      • StructuredQuery.FilterOrBuilder
      • StructuredQuery.FindNearestOrBuilder
      • 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
      • ExecutionStats
      • ExecutionStats.Builder
      • ExistenceFilter
      • ExistenceFilter.Builder
      • ExplainMetrics
      • ExplainMetrics.Builder
      • ExplainOptions
      • ExplainOptions.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
      • PlanSummary
      • PlanSummary.Builder
      • Precondition
      • Precondition.Builder
      • QueryProfileProto
      • QueryProto
      • RollbackRequest
      • RollbackRequest.Builder
      • RunAggregationQueryRequest
      • RunAggregationQueryRequest.Builder
      • RunAggregationQueryResponse
      • RunAggregationQueryResponse.Builder
      • RunQueryRequest
      • RunQueryRequest.Builder
      • RunQueryResponse
      • RunQueryResponse.Builder
      • StructuredAggregationQuery
      • StructuredAggregationQuery.Aggregation
      • StructuredAggregationQuery.Aggregation.Avg
      • StructuredAggregationQuery.Aggregation.Avg.Builder
      • StructuredAggregationQuery.Aggregation.Builder
      • StructuredAggregationQuery.Aggregation.Count
      • StructuredAggregationQuery.Aggregation.Count.Builder
      • StructuredAggregationQuery.Aggregation.Sum
      • StructuredAggregationQuery.Aggregation.Sum.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.FindNearest
      • StructuredQuery.FindNearest.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.FindNearest.DistanceMeasure
      • StructuredQuery.UnaryFilter.OperandTypeCase
      • StructuredQuery.UnaryFilter.Operator
      • Target.QueryTarget.QueryTypeCase
      • Target.ResumeTypeCase
      • Target.TargetTypeCase
      • TargetChange.TargetChangeType
      • TransactionOptions.ModeCase
      • TransactionOptions.ReadOnly.ConsistencySelectorCase
      • Value.ValueTypeCase
      • Write.OperationCase
  • google-cloud-functions
  • google-cloud-gdchardwaremanagement
  • google-cloud-gke-backup
  • google-cloud-gke-connect-gateway
  • google-cloud-gke-multi-cloud
  • google-cloud-gkehub
  • google-cloud-gsuite-addons
  • google-cloud-iamcredentials
  • google-cloud-iap
  • google-cloud-ids
  • google-cloud-infra-manager
  • google-cloud-iot
  • google-cloud-kms
  • google-cloud-kmsinventory
  • google-cloud-language
  • google-cloud-life-sciences
  • google-cloud-live-stream
  • google-cloud-logging
  • google-cloud-logging-logback
  • google-cloud-logging-servlet-initializer
  • google-cloud-managed-identities
  • google-cloud-managedkafka
  • google-cloud-mediatranslation
  • google-cloud-meet
  • google-cloud-memcache
  • google-cloud-migrationcenter
  • google-cloud-monitoring
  • google-cloud-monitoring-dashboard
  • google-cloud-monitoring-metricsscope
  • google-cloud-netapp
  • google-cloud-network-management
  • google-cloud-network-security
  • google-cloud-networkconnectivity
  • google-cloud-networkservices
  • google-cloud-nio
  • google-cloud-notebooks
  • google-cloud-notification
  • google-cloud-optimization
  • google-cloud-oracledatabase
  • google-cloud-orchestration-airflow
  • google-cloud-orgpolicy
  • google-cloud-os-config
  • google-cloud-os-login
  • google-cloud-parallelstore
  • google-cloud-parametermanager
  • google-cloud-phishingprotection
  • google-cloud-policy-troubleshooter
  • google-cloud-policysimulator
  • google-cloud-private-catalog
  • google-cloud-privilegedaccessmanager
  • google-cloud-profiler
  • google-cloud-publicca
  • google-cloud-pubsub
  • google-cloud-pubsublite
  • google-cloud-rapidmigrationassessment
  • google-cloud-recaptchaenterprise
  • google-cloud-recommendations-ai
  • google-cloud-recommender
  • google-cloud-redis
  • google-cloud-redis-cluster
  • google-cloud-resource-settings
  • google-cloud-resourcemanager
  • google-cloud-retail
  • google-cloud-run
  • google-cloud-scheduler
  • google-cloud-secretmanager
  • google-cloud-securesourcemanager
  • google-cloud-security-private-ca
  • google-cloud-securitycenter
  • google-cloud-securitycenter-settings
  • google-cloud-securitycentermanagement
  • google-cloud-securityposture
  • google-cloud-service-control
  • google-cloud-service-management
  • google-cloud-service-usage
  • google-cloud-servicedirectory
  • google-cloud-servicehealth
  • google-cloud-shell
  • google-cloud-spanner
  • google-cloud-spanner-jdbc
  • google-cloud-spanner-pgadapter
  • google-cloud-speech
  • google-cloud-storage
  • google-cloud-storage-transfer
  • google-cloud-storageinsights
  • google-cloud-talent
  • google-cloud-tasks
  • google-cloud-telcoautomation
  • google-cloud-texttospeech
  • google-cloud-tpu
  • google-cloud-trace
  • google-cloud-translate
  • google-cloud-valkey
  • google-cloud-video-intelligence
  • google-cloud-video-stitcher
  • google-cloud-video-transcoder
  • google-cloud-vision
  • google-cloud-visionai
  • google-cloud-vmmigration
  • google-cloud-vmwareengine
  • google-cloud-vpcaccess
  • google-cloud-webrisk
  • google-cloud-websecurityscanner
  • google-cloud-workflow-executions
  • google-cloud-workflows
  • google-cloud-workspaceevents
  • google-cloud-workstations
  • google-cloudevent-types
  • google-common-protos
  • google-http-client
  • google-iam
  • google-iam-admin
  • google-iam-policy
  • google-identity-accesscontextmanager
  • google-oauth-client
  • google-shopping-css
  • google-shopping-merchant-accounts
  • google-shopping-merchant-conversions
  • google-shopping-merchant-datasources
  • google-shopping-merchant-inventories
  • google-shopping-merchant-lfp
  • google-shopping-merchant-notifications
  • google-shopping-merchant-products
  • google-shopping-merchant-promotions
  • google-shopping-merchant-quota
  • google-shopping-merchant-reports
  • google-shopping-merchant-reviews
  • grafeas
  • jdbc-socket-factory
  • protobuf
  • pubsub-group-kafka-connector
  • pubsublite-kafka
  • pubsublite-spark-sql-streaming
  • 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
  • Access and resources management
  • Costs and usage management
  • Google Cloud SDK, languages, frameworks, and tools
  • Infrastructure as code
  • Migration
  • 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
  • Home
  • Java
  • Documentation
  • Reference
Stay organized with collections Save and categorize content based on your preferences.
  • 3.30.11 (latest)
  • 3.30.9
  • 3.28.0
  • 3.27.2
  • 3.26.5
  • 3.25.1
  • 3.24.3
  • 3.22.0
  • 3.21.4
  • 3.20.0
  • 3.17.0
  • 3.16.3
  • 3.15.7
  • 3.14.4
  • 3.13.2
  • 3.12.1
  • 3.11.0
  • 3.10.0
  • 3.9.6
  • 3.8.2
  • 3.7.10
  • 3.6.0
  • 3.5.0
  • 3.4.2
  • 3.3.0
  • 3.2.0
  • 3.1.0
  • 3.0.21

Package com.google.cloud.firestore.encoding (3.30.9)

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.cloud.firestore.encoding.CustomClassMapper Helper class to convert to/from custom POJO classes and plain Java types.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-04-17 UTC.

  • Why Google

    • Choosing Google Cloud
    • Trust and security
    • Modern Infrastructure Cloud
    • Multicloud
    • Global infrastructure
    • Customers and case studies
    • Analyst reports
    • Whitepapers
  • Products and pricing

    • See all products
    • See all solutions
    • Google Cloud for Startups
    • Google Cloud Marketplace
    • Google Cloud pricing
    • Contact sales
  • Support

    • Google Cloud Community
    • Support
    • Release Notes
    • System status
  • Resources

    • GitHub
    • Getting Started with Google Cloud
    • Google Cloud documentation
    • Code samples
    • Cloud Architecture Center
    • Training and Certification
    • Developer Center
  • Engage

    • Blog
    • Events
    • X (Twitter)
    • Google Cloud on YouTube
    • Google Cloud Tech on YouTube
    • Become a Partner
    • Google Cloud Affiliate Program
    • Press Corner
  • About Google
  • Privacy
  • Site terms
  • Google Cloud terms
  • Manage cookies
  • Our third decade of climate action: join us
  • Sign up for the Google Cloud newsletter Subscribe
  • English
  • Deutsch
  • Español – América Latina
  • Français
  • Português – Brasil
  • 中文 – 简体
  • 日本語
  • 한국어