Firestore v1 API - Namespace Google.Cloud.Firestore.V1 (3.6.0)

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 query, unlike document queries which can have different fields present for each result.

An array value.

The request for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

The streamed response for [Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].

The request for [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

The response from [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].

The request for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

The response for [Firestore.BeginTransaction][google.firestore.v1.Firestore.BeginTransaction].

A sequence of bits, encoded in a byte array.

Each byte in the bitmap byte array stores 8 bits of the sequence. The only exception is the last byte, which may store 8 or fewer bits. The padding defines the number of bits of the last byte to be ignored as "padding". The values of these "padding" bits are unspecified and must be ignored.

To retrieve the first bit, bit 0, calculate: (bitmap[0] & 0x01) != 0. To retrieve the second bit, bit 1, calculate: (bitmap[0] & 0x02) != 0. To retrieve the third bit, bit 2, calculate: (bitmap[0] & 0x04) != 0. To retrieve the fourth bit, bit 3, calculate: (bitmap[0] & 0x08) != 0. To retrieve bit n, calculate: (bitmap[n / 8] & (0x01 << (n % 8))) != 0.

The "size" of a BitSequence (the number of bits it contains) is calculated by this formula: (bitmap.length * 8) - padding.

A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter).

The bloom filter hashes the entries with MD5 and treats the resulting 128-bit hash as 2 distinct 64-bit hash values, interpreted as unsigned integers using 2's complement encoding.

These two hash values, named h1 and h2, are then used to compute the hash_count hash values using the formula, starting at i=0:

h(i) = h1 + (i * h2)

These resulting values are then taken modulo the number of bits in the bloom filter to get the bits of the bloom filter to test for the given entry.

The request for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

The response for [Firestore.Commit][google.firestore.v1.Firestore.Commit].

The request for [Firestore.CreateDocument][google.firestore.v1.Firestore.CreateDocument].

A position in a query result set.

The request for [Firestore.DeleteDocument][google.firestore.v1.Firestore.DeleteDocument].

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

A [Document][google.firestore.v1.Document] has changed.

May be the result of multiple [writes][google.firestore.v1.Write], including deletes, that ultimately resulted in a new value for the [Document][google.firestore.v1.Document].

Multiple [DocumentChange][google.firestore.v1.DocumentChange] messages may be returned for the same logical change, if multiple targets are affected.

A [Document][google.firestore.v1.Document] has been deleted.

May be the result of multiple [writes][google.firestore.v1.Write], including updates, the last of which deleted the [Document][google.firestore.v1.Document].

Multiple [DocumentDelete][google.firestore.v1.DocumentDelete] messages may be returned for the same logical delete, if multiple targets are affected.

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. This is different from standard field masks, as this is always scoped to a [Document][google.firestore.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value].

A [Document][google.firestore.v1.Document] has been removed from the view of the targets.

Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document.

Multiple [DocumentRemove][google.firestore.v1.DocumentRemove] messages may be returned for the same logical write or delete, if multiple targets are affected.

A transformation of a document.

Container for nested types declared in the DocumentTransform message type.

A transformation of a field of the document.

Container for nested types declared in the FieldTransform message type.

Execution statistics for the query.

A digest of all the documents that match a given target.

Explain metrics for the query.

Explain options for the query.

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 your mobile, web, and IoT apps at global scale. Its client libraries provide live synchronization and offline support, while its security features and integrations with Firebase and Google Cloud Platform accelerate building truly serverless apps.

Base class for server-side implementations of Firestore

Client for Firestore

Firestore client wrapper, for convenient use.

Server streaming methods for BatchGetDocuments(BatchGetDocumentsRequest, CallSettings) .

Bidirectional streaming methods for Listen(CallSettings, BidirectionalStreamingSettings).

Server streaming methods for RunAggregationQuery(RunAggregationQueryRequest, CallSettings).

Server streaming methods for RunQuery(RunQueryRequest, CallSettings).

Bidirectional streaming methods for Write(CallSettings, BidirectionalStreamingSettings).

Builder class for FirestoreClient to provide simple configuration of credentials, endpoint etc.

Firestore client wrapper implementation, for convenient use.

Settings for FirestoreClient instances.

The request for [Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].

The request for [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

The response from [Firestore.ListCollectionIds][google.firestore.v1.Firestore.ListCollectionIds].

The request for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

The response for [Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].

A request for [Firestore.Listen][google.firestore.v1.Firestore.Listen]

The response for [Firestore.Listen][google.firestore.v1.Firestore.Listen].

A map value.

The request for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

The response for [Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].

Planning phase information for the query.

A precondition on a document, used for conditional operations.

The request for [Firestore.Rollback][google.firestore.v1.Firestore.Rollback].

The request for [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].

The response for [Firestore.RunAggregationQuery][google.firestore.v1.Firestore.RunAggregationQuery].

The request for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

The response for [Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].

Firestore query for running an aggregation over a [StructuredQuery][google.firestore.v1.StructuredQuery].

Container for nested types declared in the StructuredAggregationQuery message type.

Defines an aggregation that produces a single result.

Container for nested types declared in the Aggregation message type.

Average of the values of the requested field.

• Only numeric values will be aggregated. All non-numeric values including NULL are skipped.

• If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.

• If the aggregated value set is empty, returns NULL.

• Always returns the result as a double.

Count of documents that match the query.

The COUNT(*) aggregation function operates on the entire document so it does not require a field reference.

Sum of the values of the requested field.

• Only numeric values will be aggregated. All non-numeric values including NULL are skipped.

• If the aggregated values contain NaN, returns NaN. Infinity math follows IEEE-754 standards.

• If the aggregated value set is empty, returns 0.

• Returns a 64-bit integer if all aggregated numbers are integers and the sum result does not overflow. Otherwise, the result is returned as a double. Note that even if all the aggregated values are integers, the result is returned as a double if it cannot fit within a 64-bit signed integer. When this occurs, the returned value will lose precision.

• When underflow occurs, floating-point aggregation is non-deterministic. This means that running the same query repeatedly without any changes to the underlying values could produce slightly different results each time. In those cases, values should be stored as integers over floating-point numbers.

A Firestore query.

The query stages are executed in the following order:

1. from
2. where
3. select
4. order_by + start_at + end_at
5. offset
6. limit

Container for nested types declared in the StructuredQuery message type.

A selection of a collection, such as messages as m1.

A filter that merges multiple other filters using the given operator.

Container for nested types declared in the CompositeFilter message type.

A filter on a specific field.

Container for nested types declared in the FieldFilter message type.

A reference to a field in a document, ex: stats.operations.

A filter.

Nearest Neighbors search config.

Container for nested types declared in the FindNearest message type.

An order on a field.

The projection of document's fields to return.

A filter with a single operand.

Container for nested types declared in the UnaryFilter message type.

A specification of a set of documents to listen to.

Container for nested types declared in the Target message type.

A target specified by a set of documents names.

A target specified by a query.

Targets being watched have changed.

Container for nested types declared in the TargetChange message type.

Options for creating a new transaction.

Container for nested types declared in the TransactionOptions message type.

Options for a transaction that can only be used to read documents.

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. transactions.

The request for [Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].

A message that can hold any of the supported value types.

A write on a document.

The request for [Firestore.Write][google.firestore.v1.Firestore.Write].

The first request creates a stream, or resumes an existing one from a token.

When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request.

When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.

The response for [Firestore.Write][google.firestore.v1.Firestore.Write].

The result of applying a write.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "result" oneof.

Enum of possible cases for the "transform_type" oneof.

A value that is calculated by the server.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "target_change" oneof.

Enum of possible cases for the "response_type" oneof.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "query_type" oneof.

Enum of possible cases for the "condition_type" oneof.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "query_type" oneof.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "query_type" oneof.

Enum of possible cases for the "continuation_selector" oneof.

Enum of possible cases for the "query_type" oneof.

Enum of possible cases for the "operator" oneof.

A composite filter operator.

A sort direction.

A field filter operator.

Enum of possible cases for the "filter_type" oneof.

The distance measure to use when comparing vectors.

Enum of possible cases for the "operand_type" oneof.

A unary operator.

Enum of possible cases for the "resume_type" oneof.

Enum of possible cases for the "target_type" oneof.

Enum of possible cases for the "query_type" oneof.

The type of change.

Enum of possible cases for the "mode" oneof.

Enum of possible cases for the "consistency_selector" oneof.

Enum of possible cases for the "value_type" oneof.

Enum of possible cases for the "operation" oneof.