Package com.google.firestore.v1 (3.22.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.v1.AggregationResult The result of a single bucket from a Firestore aggregation query. The keys of aggregate_fields are the same for all results in an aggregation
com.google.firestore.v1.AggregationResult.Builder The result of a single bucket from a Firestore aggregation query. The keys of aggregate_fields are the same for all results in an aggregation
com.google.firestore.v1.AggregationResultProto
com.google.firestore.v1.AnyPathName AUTO-GENERATED DOCUMENTATION AND CLASS
com.google.firestore.v1.AnyPathName.Builder Builder for AnyPathName.
com.google.firestore.v1.ArrayValue An array value.
com.google.firestore.v1.ArrayValue.Builder An array value.
com.google.firestore.v1.BatchGetDocumentsRequest The request for Firestore.BatchGetDocuments.
com.google.firestore.v1.BatchGetDocumentsRequest.Builder The request for Firestore.BatchGetDocuments.
com.google.firestore.v1.BatchGetDocumentsResponse The streamed response for Firestore.BatchGetDocuments.
com.google.firestore.v1.BatchGetDocumentsResponse.Builder The streamed response for Firestore.BatchGetDocuments.
com.google.firestore.v1.BatchWriteRequest The request for Firestore.BatchWrite.
com.google.firestore.v1.BatchWriteRequest.Builder The request for Firestore.BatchWrite.
com.google.firestore.v1.BatchWriteResponse The response from Firestore.BatchWrite.
com.google.firestore.v1.BatchWriteResponse.Builder The response from Firestore.BatchWrite.
com.google.firestore.v1.BeginTransactionRequest The request for Firestore.BeginTransaction.
com.google.firestore.v1.BeginTransactionRequest.Builder The request for Firestore.BeginTransaction.
com.google.firestore.v1.BeginTransactionResponse The response for Firestore.BeginTransaction.
com.google.firestore.v1.BeginTransactionResponse.Builder The response for Firestore.BeginTransaction.
com.google.firestore.v1.BitSequence A sequence of bits, encoded in a byte array. Each byte in the bitmap byte array stores 8 bits of the sequence. The only
com.google.firestore.v1.BitSequence.Builder A sequence of bits, encoded in a byte array. Each byte in the bitmap byte array stores 8 bits of the sequence. The only
com.google.firestore.v1.BloomFilter A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter). The bloom filter hashes the entries with MD5 and treats the resulting 128-bit
com.google.firestore.v1.BloomFilter.Builder A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter). The bloom filter hashes the entries with MD5 and treats the resulting 128-bit
com.google.firestore.v1.BloomFilterProto
com.google.firestore.v1.CommitRequest The request for Firestore.Commit.
com.google.firestore.v1.CommitRequest.Builder The request for Firestore.Commit.
com.google.firestore.v1.CommitResponse The response for Firestore.Commit.
com.google.firestore.v1.CommitResponse.Builder The response for Firestore.Commit.
com.google.firestore.v1.CommonProto
com.google.firestore.v1.CreateDocumentRequest The request for Firestore.CreateDocument.
com.google.firestore.v1.CreateDocumentRequest.Builder The request for Firestore.CreateDocument.
com.google.firestore.v1.Cursor A position in a query result set.
com.google.firestore.v1.Cursor.Builder A position in a query result set.
com.google.firestore.v1.DatabaseRootName AUTO-GENERATED DOCUMENTATION AND CLASS
com.google.firestore.v1.DatabaseRootName.Builder Builder for DatabaseRootName.
com.google.firestore.v1.DeleteDocumentRequest The request for Firestore.DeleteDocument.
com.google.firestore.v1.DeleteDocumentRequest.Builder The request for Firestore.DeleteDocument.
com.google.firestore.v1.Document A Firestore document. Must not exceed 1 MiB - 4 bytes.
com.google.firestore.v1.Document.Builder A Firestore document. Must not exceed 1 MiB - 4 bytes.
com.google.firestore.v1.DocumentChange A Document has changed. May be the result of multiple writes, including
com.google.firestore.v1.DocumentChange.Builder A Document has changed. May be the result of multiple writes, including
com.google.firestore.v1.DocumentDelete A Document has been deleted. May be the result of multiple writes, including
com.google.firestore.v1.DocumentDelete.Builder A Document has been deleted. May be the result of multiple writes, including
com.google.firestore.v1.DocumentMask A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields.
com.google.firestore.v1.DocumentMask.Builder A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields.
com.google.firestore.v1.DocumentPathName AUTO-GENERATED DOCUMENTATION AND CLASS
com.google.firestore.v1.DocumentPathName.Builder Builder for DocumentPathName.
com.google.firestore.v1.DocumentProto
com.google.firestore.v1.DocumentRemove A Document has been removed from the view of the targets.
com.google.firestore.v1.DocumentRemove.Builder A Document has been removed from the view of the targets.
com.google.firestore.v1.DocumentRootName AUTO-GENERATED DOCUMENTATION AND CLASS
com.google.firestore.v1.DocumentRootName.Builder Builder for DocumentRootName.
com.google.firestore.v1.DocumentTransform A transformation of a document.
com.google.firestore.v1.DocumentTransform.Builder A transformation of a document.
com.google.firestore.v1.DocumentTransform.FieldTransform A transformation of a field of the document.
com.google.firestore.v1.DocumentTransform.FieldTransform.Builder A transformation of a field of the document.
com.google.firestore.v1.ExecutionStats Execution statistics for the query.
com.google.firestore.v1.ExecutionStats.Builder Execution statistics for the query.
com.google.firestore.v1.ExistenceFilter A digest of all the documents that match a given target.
com.google.firestore.v1.ExistenceFilter.Builder A digest of all the documents that match a given target.
com.google.firestore.v1.ExplainMetrics Explain metrics for the query.
com.google.firestore.v1.ExplainMetrics.Builder Explain metrics for the query.
com.google.firestore.v1.ExplainOptions Explain options for the query.
com.google.firestore.v1.ExplainOptions.Builder Explain options for the query.
com.google.firestore.v1.FirestoreGrpc The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for
com.google.firestore.v1.FirestoreGrpc.FirestoreImplBase Base class for the server implementation of the service Firestore. The Cloud Firestore service.
com.google.firestore.v1.FirestoreProto
com.google.firestore.v1.GetDocumentRequest The request for Firestore.GetDocument.
com.google.firestore.v1.GetDocumentRequest.Builder The request for Firestore.GetDocument.
com.google.firestore.v1.ListCollectionIdsRequest The request for Firestore.ListCollectionIds.
com.google.firestore.v1.ListCollectionIdsRequest.Builder The request for Firestore.ListCollectionIds.
com.google.firestore.v1.ListCollectionIdsResponse The response from Firestore.ListCollectionIds.
com.google.firestore.v1.ListCollectionIdsResponse.Builder The response from Firestore.ListCollectionIds.
com.google.firestore.v1.ListDocumentsRequest The request for Firestore.ListDocuments.
com.google.firestore.v1.ListDocumentsRequest.Builder The request for Firestore.ListDocuments.
com.google.firestore.v1.ListDocumentsResponse The response for Firestore.ListDocuments.
com.google.firestore.v1.ListDocumentsResponse.Builder The response for Firestore.ListDocuments.
com.google.firestore.v1.ListenRequest A request for Firestore.Listen
com.google.firestore.v1.ListenRequest.Builder A request for Firestore.Listen
com.google.firestore.v1.ListenResponse The response for Firestore.Listen.
com.google.firestore.v1.ListenResponse.Builder The response for Firestore.Listen.
com.google.firestore.v1.MapValue A map value.
com.google.firestore.v1.MapValue.Builder A map value.
com.google.firestore.v1.PartitionQueryRequest The request for Firestore.PartitionQuery.
com.google.firestore.v1.PartitionQueryRequest.Builder The request for Firestore.PartitionQuery.
com.google.firestore.v1.PartitionQueryResponse The response for Firestore.PartitionQuery.
com.google.firestore.v1.PartitionQueryResponse.Builder The response for Firestore.PartitionQuery.
com.google.firestore.v1.PlanSummary Planning phase information for the query.
com.google.firestore.v1.PlanSummary.Builder Planning phase information for the query.
com.google.firestore.v1.Precondition A precondition on a document, used for conditional operations.
com.google.firestore.v1.Precondition.Builder A precondition on a document, used for conditional operations.
com.google.firestore.v1.QueryProfileProto
com.google.firestore.v1.QueryProto
com.google.firestore.v1.RollbackRequest The request for Firestore.Rollback.
com.google.firestore.v1.RollbackRequest.Builder The request for Firestore.Rollback.
com.google.firestore.v1.RunAggregationQueryRequest The request for Firestore.RunAggregationQuery.
com.google.firestore.v1.RunAggregationQueryRequest.Builder The request for Firestore.RunAggregationQuery.
com.google.firestore.v1.RunAggregationQueryResponse The response for Firestore.RunAggregationQuery.
com.google.firestore.v1.RunAggregationQueryResponse.Builder The response for Firestore.RunAggregationQuery.
com.google.firestore.v1.RunQueryRequest The request for Firestore.RunQuery.
com.google.firestore.v1.RunQueryRequest.Builder The request for Firestore.RunQuery.
com.google.firestore.v1.RunQueryResponse The response for Firestore.RunQuery.
com.google.firestore.v1.RunQueryResponse.Builder The response for Firestore.RunQuery.
com.google.firestore.v1.StructuredAggregationQuery Firestore query for running an aggregation over a StructuredQuery.
com.google.firestore.v1.StructuredAggregationQuery.Aggregation Defines an aggregation that produces a single result.
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg Average of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg.Builder Average of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Builder Defines an aggregation that produces a single result.
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count Count of documents that match the query. The COUNT() aggregation function operates on the entire document
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Count.Builder Count of documents that match the query. The COUNT() aggregation function operates on the entire document
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum Sum of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum.Builder Sum of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values
com.google.firestore.v1.StructuredAggregationQuery.Builder Firestore query for running an aggregation over a StructuredQuery.
com.google.firestore.v1.StructuredQuery A Firestore query. The query stages are executed in the following order:
com.google.firestore.v1.StructuredQuery.Builder A Firestore query. The query stages are executed in the following order:
com.google.firestore.v1.StructuredQuery.CollectionSelector A selection of a collection, such as messages as m1.
com.google.firestore.v1.StructuredQuery.CollectionSelector.Builder A selection of a collection, such as messages as m1.
com.google.firestore.v1.StructuredQuery.CompositeFilter A filter that merges multiple other filters using the given operator.
com.google.firestore.v1.StructuredQuery.CompositeFilter.Builder A filter that merges multiple other filters using the given operator.
com.google.firestore.v1.StructuredQuery.FieldFilter A filter on a specific field.
com.google.firestore.v1.StructuredQuery.FieldFilter.Builder A filter on a specific field.
com.google.firestore.v1.StructuredQuery.FieldReference A reference to a field in a document, ex: stats.operations.
com.google.firestore.v1.StructuredQuery.FieldReference.Builder A reference to a field in a document, ex: stats.operations.
com.google.firestore.v1.StructuredQuery.Filter A filter.
com.google.firestore.v1.StructuredQuery.Filter.Builder A filter.
com.google.firestore.v1.StructuredQuery.FindNearest Nearest Neighbors search config.
com.google.firestore.v1.StructuredQuery.FindNearest.Builder Nearest Neighbors search config.
com.google.firestore.v1.StructuredQuery.Order An order on a field.
com.google.firestore.v1.StructuredQuery.Order.Builder An order on a field.
com.google.firestore.v1.StructuredQuery.Projection The projection of document's fields to return.
com.google.firestore.v1.StructuredQuery.Projection.Builder The projection of document's fields to return.
com.google.firestore.v1.StructuredQuery.UnaryFilter A filter with a single operand.
com.google.firestore.v1.StructuredQuery.UnaryFilter.Builder A filter with a single operand.
com.google.firestore.v1.Target A specification of a set of documents to listen to.
com.google.firestore.v1.Target.Builder A specification of a set of documents to listen to.
com.google.firestore.v1.Target.DocumentsTarget A target specified by a set of documents names.
com.google.firestore.v1.Target.DocumentsTarget.Builder A target specified by a set of documents names.
com.google.firestore.v1.Target.QueryTarget A target specified by a query.
com.google.firestore.v1.Target.QueryTarget.Builder A target specified by a query.
com.google.firestore.v1.TargetChange Targets being watched have changed.
com.google.firestore.v1.TargetChange.Builder Targets being watched have changed.
com.google.firestore.v1.TransactionOptions Options for creating a new transaction.
com.google.firestore.v1.TransactionOptions.Builder Options for creating a new transaction.
com.google.firestore.v1.TransactionOptions.ReadOnly Options for a transaction that can only be used to read documents.
com.google.firestore.v1.TransactionOptions.ReadOnly.Builder Options for a transaction that can only be used to read documents.
com.google.firestore.v1.TransactionOptions.ReadWrite Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write.
com.google.firestore.v1.TransactionOptions.ReadWrite.Builder Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write.
com.google.firestore.v1.UpdateDocumentRequest The request for Firestore.UpdateDocument.
com.google.firestore.v1.UpdateDocumentRequest.Builder The request for Firestore.UpdateDocument.
com.google.firestore.v1.Value A message that can hold any of the supported value types.
com.google.firestore.v1.Value.Builder A message that can hold any of the supported value types.
com.google.firestore.v1.Write A write on a document.
com.google.firestore.v1.Write.Builder A write on a document.
com.google.firestore.v1.WriteProto
com.google.firestore.v1.WriteRequest The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token.
com.google.firestore.v1.WriteRequest.Builder The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token.
com.google.firestore.v1.WriteResponse The response for Firestore.Write.
com.google.firestore.v1.WriteResponse.Builder The response for Firestore.Write.
com.google.firestore.v1.WriteResult The result of applying a write.
com.google.firestore.v1.WriteResult.Builder The result of applying a write.

Interfaces

Interface Description
com.google.firestore.v1.AggregationResultOrBuilder
com.google.firestore.v1.ArrayValueOrBuilder
com.google.firestore.v1.BatchGetDocumentsRequestOrBuilder
com.google.firestore.v1.BatchGetDocumentsResponseOrBuilder
com.google.firestore.v1.BatchWriteRequestOrBuilder
com.google.firestore.v1.BatchWriteResponseOrBuilder
com.google.firestore.v1.BeginTransactionRequestOrBuilder
com.google.firestore.v1.BeginTransactionResponseOrBuilder
com.google.firestore.v1.BitSequenceOrBuilder
com.google.firestore.v1.BloomFilterOrBuilder
com.google.firestore.v1.CommitRequestOrBuilder
com.google.firestore.v1.CommitResponseOrBuilder
com.google.firestore.v1.CreateDocumentRequestOrBuilder
com.google.firestore.v1.CursorOrBuilder
com.google.firestore.v1.DeleteDocumentRequestOrBuilder
com.google.firestore.v1.DocumentChangeOrBuilder
com.google.firestore.v1.DocumentDeleteOrBuilder
com.google.firestore.v1.DocumentMaskOrBuilder
com.google.firestore.v1.DocumentOrBuilder
com.google.firestore.v1.DocumentRemoveOrBuilder
com.google.firestore.v1.DocumentTransform.FieldTransformOrBuilder
com.google.firestore.v1.DocumentTransformOrBuilder
com.google.firestore.v1.ExecutionStatsOrBuilder
com.google.firestore.v1.ExistenceFilterOrBuilder
com.google.firestore.v1.ExplainMetricsOrBuilder
com.google.firestore.v1.ExplainOptionsOrBuilder
com.google.firestore.v1.FirestoreGrpc.AsyncService The Cloud Firestore service. Cloud Firestore is a fast, fully managed, serverless, cloud-native NoSQL document database that simplifies storing, syncing, and querying data for
com.google.firestore.v1.GetDocumentRequestOrBuilder
com.google.firestore.v1.ListCollectionIdsRequestOrBuilder
com.google.firestore.v1.ListCollectionIdsResponseOrBuilder
com.google.firestore.v1.ListDocumentsRequestOrBuilder
com.google.firestore.v1.ListDocumentsResponseOrBuilder
com.google.firestore.v1.ListenRequestOrBuilder
com.google.firestore.v1.ListenResponseOrBuilder
com.google.firestore.v1.MapValueOrBuilder
com.google.firestore.v1.PartitionQueryRequestOrBuilder
com.google.firestore.v1.PartitionQueryResponseOrBuilder
com.google.firestore.v1.PlanSummaryOrBuilder
com.google.firestore.v1.PreconditionOrBuilder
com.google.firestore.v1.RollbackRequestOrBuilder
com.google.firestore.v1.RunAggregationQueryRequestOrBuilder
com.google.firestore.v1.RunAggregationQueryResponseOrBuilder
com.google.firestore.v1.RunQueryRequestOrBuilder
com.google.firestore.v1.RunQueryResponseOrBuilder
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.AvgOrBuilder
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.CountOrBuilder
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.SumOrBuilder
com.google.firestore.v1.StructuredAggregationQuery.AggregationOrBuilder
com.google.firestore.v1.StructuredAggregationQueryOrBuilder
com.google.firestore.v1.StructuredQuery.CollectionSelectorOrBuilder
com.google.firestore.v1.StructuredQuery.CompositeFilterOrBuilder
com.google.firestore.v1.StructuredQuery.FieldFilterOrBuilder
com.google.firestore.v1.StructuredQuery.FieldReferenceOrBuilder
com.google.firestore.v1.StructuredQuery.FilterOrBuilder
com.google.firestore.v1.StructuredQuery.FindNearestOrBuilder
com.google.firestore.v1.StructuredQuery.OrderOrBuilder
com.google.firestore.v1.StructuredQuery.ProjectionOrBuilder
com.google.firestore.v1.StructuredQuery.UnaryFilterOrBuilder
com.google.firestore.v1.StructuredQueryOrBuilder
com.google.firestore.v1.Target.DocumentsTargetOrBuilder
com.google.firestore.v1.Target.QueryTargetOrBuilder
com.google.firestore.v1.TargetChangeOrBuilder
com.google.firestore.v1.TargetOrBuilder
com.google.firestore.v1.TransactionOptions.ReadOnlyOrBuilder
com.google.firestore.v1.TransactionOptions.ReadWriteOrBuilder
com.google.firestore.v1.TransactionOptionsOrBuilder
com.google.firestore.v1.UpdateDocumentRequestOrBuilder
com.google.firestore.v1.ValueOrBuilder
com.google.firestore.v1.WriteOrBuilder
com.google.firestore.v1.WriteRequestOrBuilder
com.google.firestore.v1.WriteResponseOrBuilder
com.google.firestore.v1.WriteResultOrBuilder

Enums

Enum Description
com.google.firestore.v1.BatchGetDocumentsRequest.ConsistencySelectorCase
com.google.firestore.v1.BatchGetDocumentsResponse.ResultCase
com.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue A value that is calculated by the server.
com.google.firestore.v1.DocumentTransform.FieldTransform.TransformTypeCase
com.google.firestore.v1.GetDocumentRequest.ConsistencySelectorCase
com.google.firestore.v1.ListCollectionIdsRequest.ConsistencySelectorCase
com.google.firestore.v1.ListDocumentsRequest.ConsistencySelectorCase
com.google.firestore.v1.ListenRequest.TargetChangeCase
com.google.firestore.v1.ListenResponse.ResponseTypeCase
com.google.firestore.v1.PartitionQueryRequest.ConsistencySelectorCase
com.google.firestore.v1.PartitionQueryRequest.QueryTypeCase
com.google.firestore.v1.Precondition.ConditionTypeCase
com.google.firestore.v1.RunAggregationQueryRequest.ConsistencySelectorCase
com.google.firestore.v1.RunAggregationQueryRequest.QueryTypeCase
com.google.firestore.v1.RunQueryRequest.ConsistencySelectorCase
com.google.firestore.v1.RunQueryRequest.QueryTypeCase
com.google.firestore.v1.RunQueryResponse.ContinuationSelectorCase
com.google.firestore.v1.StructuredAggregationQuery.Aggregation.OperatorCase
com.google.firestore.v1.StructuredAggregationQuery.QueryTypeCase
com.google.firestore.v1.StructuredQuery.CompositeFilter.Operator A composite filter operator.
com.google.firestore.v1.StructuredQuery.Direction A sort direction.
com.google.firestore.v1.StructuredQuery.FieldFilter.Operator A field filter operator.
com.google.firestore.v1.StructuredQuery.Filter.FilterTypeCase
com.google.firestore.v1.StructuredQuery.FindNearest.DistanceMeasure The distance measure to use when comparing vectors.
com.google.firestore.v1.StructuredQuery.UnaryFilter.OperandTypeCase
com.google.firestore.v1.StructuredQuery.UnaryFilter.Operator A unary operator.
com.google.firestore.v1.Target.QueryTarget.QueryTypeCase
com.google.firestore.v1.Target.ResumeTypeCase
com.google.firestore.v1.Target.TargetTypeCase
com.google.firestore.v1.TargetChange.TargetChangeType The type of change.
com.google.firestore.v1.TransactionOptions.ModeCase
com.google.firestore.v1.TransactionOptions.ReadOnly.ConsistencySelectorCase
com.google.firestore.v1.Value.ValueTypeCase
com.google.firestore.v1.Write.OperationCase