Package com.google.firestore.v1 (3.20.0)

Classes

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

Protobuf type google.firestore.v1.AggregationResult

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

Protobuf type google.firestore.v1.AggregationResult

ArrayValue

An array value.

Protobuf type google.firestore.v1.ArrayValue

ArrayValue.Builder

An array value.

Protobuf type google.firestore.v1.ArrayValue

BatchGetDocumentsRequest

The request for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsRequest

BatchGetDocumentsRequest.Builder

The request for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsRequest

BatchGetDocumentsResponse

The streamed response for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

BatchGetDocumentsResponse.Builder

The streamed response for Firestore.BatchGetDocuments.

Protobuf type google.firestore.v1.BatchGetDocumentsResponse

BatchWriteRequest

The request for Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteRequest

BatchWriteRequest.Builder

The request for Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteRequest

BatchWriteResponse

The response from Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteResponse

BatchWriteResponse.Builder

The response from Firestore.BatchWrite.

Protobuf type google.firestore.v1.BatchWriteResponse

BeginTransactionRequest

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

BeginTransactionRequest.Builder

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

BeginTransactionResponse

The response for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionResponse

BeginTransactionResponse.Builder

The response for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionResponse

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

Protobuf type google.firestore.v1.BitSequence

BitSequence.Builder

A sequence of bits, encoded in a byte array.

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

Protobuf type google.firestore.v1.BitSequence

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

Protobuf type google.firestore.v1.BloomFilter

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

Protobuf type google.firestore.v1.BloomFilter

BloomFilterProto

CommitRequest

The request for Firestore.Commit.

Protobuf type google.firestore.v1.CommitRequest

CommitRequest.Builder

The request for Firestore.Commit.

Protobuf type google.firestore.v1.CommitRequest

CommitResponse

The response for Firestore.Commit.

Protobuf type google.firestore.v1.CommitResponse

CommitResponse.Builder

The response for Firestore.Commit.

Protobuf type google.firestore.v1.CommitResponse

CommonProto

CreateDocumentRequest

The request for Firestore.CreateDocument.

Protobuf type google.firestore.v1.CreateDocumentRequest

CreateDocumentRequest.Builder

The request for Firestore.CreateDocument.

Protobuf type google.firestore.v1.CreateDocumentRequest

Cursor

A position in a query result set.

Protobuf type google.firestore.v1.Cursor

Cursor.Builder

A position in a query result set.

Protobuf type google.firestore.v1.Cursor

DatabaseRootName

AUTO-GENERATED DOCUMENTATION AND CLASS

DatabaseRootName.Builder

Builder for DatabaseRootName.

DeleteDocumentRequest

The request for Firestore.DeleteDocument.

Protobuf type google.firestore.v1.DeleteDocumentRequest

DeleteDocumentRequest.Builder

The request for Firestore.DeleteDocument.

Protobuf type google.firestore.v1.DeleteDocumentRequest

Document

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

Protobuf type google.firestore.v1.Document

Document.Builder

A Firestore document.

Must not exceed 1 MiB - 4 bytes.

Protobuf type google.firestore.v1.Document

DocumentChange

A Document has changed.

May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document.

Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentChange

DocumentChange.Builder

A Document has changed.

May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document.

Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentChange

DocumentDelete

A Document has been deleted.

May be the result of multiple writes, including updates, the last of which deleted the Document.

Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentDelete

DocumentDelete.Builder

A Document has been deleted.

May be the result of multiple writes, including updates, the last of which deleted the Document.

Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentDelete

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

Protobuf type google.firestore.v1.DocumentMask

DocumentMask.Builder

Protobuf type google.firestore.v1.DocumentMask

DocumentPathName

AUTO-GENERATED DOCUMENTATION AND CLASS

DocumentPathName.Builder

Builder for DocumentPathName.

DocumentProto

DocumentRemove

A 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 messages may be returned for the same logical write or delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentRemove

DocumentRemove.Builder

A 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 messages may be returned for the same logical write or delete, if multiple targets are affected.

Protobuf type google.firestore.v1.DocumentRemove

DocumentRootName

AUTO-GENERATED DOCUMENTATION AND CLASS

DocumentRootName.Builder

Builder for DocumentRootName.

DocumentTransform

A transformation of a document.

Protobuf type google.firestore.v1.DocumentTransform

DocumentTransform.Builder

A transformation of a document.

Protobuf type google.firestore.v1.DocumentTransform

DocumentTransform.FieldTransform

A transformation of a field of the document.

Protobuf type google.firestore.v1.DocumentTransform.FieldTransform

DocumentTransform.FieldTransform.Builder

A transformation of a field of the document.

Protobuf type google.firestore.v1.DocumentTransform.FieldTransform

ExecutionStats

Execution statistics for the query.

Protobuf type google.firestore.v1.ExecutionStats

ExecutionStats.Builder

Execution statistics for the query.

Protobuf type google.firestore.v1.ExecutionStats

ExistenceFilter

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

Protobuf type google.firestore.v1.ExistenceFilter

ExistenceFilter.Builder

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

Protobuf type google.firestore.v1.ExistenceFilter

ExplainMetrics

Explain metrics for the query.

Protobuf type google.firestore.v1.ExplainMetrics

ExplainMetrics.Builder

Explain metrics for the query.

Protobuf type google.firestore.v1.ExplainMetrics

ExplainOptions

Explain options for the query.

Protobuf type google.firestore.v1.ExplainOptions

ExplainOptions.Builder

Explain options for the query.

Protobuf type google.firestore.v1.ExplainOptions

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

FirestoreGrpc.FirestoreBlockingStub

A stub to allow clients to do synchronous rpc calls to service Firestore.

FirestoreGrpc.FirestoreFutureStub

A stub to allow clients to do ListenableFuture-style rpc calls to service Firestore.

FirestoreGrpc.FirestoreImplBase

Base class for the server implementation of the service Firestore.

FirestoreGrpc.FirestoreStub

A stub to allow clients to do asynchronous rpc calls to service Firestore.

FirestoreProto

GetDocumentRequest

The request for Firestore.GetDocument.

Protobuf type google.firestore.v1.GetDocumentRequest

GetDocumentRequest.Builder

The request for Firestore.GetDocument.

Protobuf type google.firestore.v1.GetDocumentRequest

ListCollectionIdsRequest

The request for Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsRequest

ListCollectionIdsRequest.Builder

The request for Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsRequest

ListCollectionIdsResponse

The response from Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsResponse

ListCollectionIdsResponse.Builder

The response from Firestore.ListCollectionIds.

Protobuf type google.firestore.v1.ListCollectionIdsResponse

ListDocumentsRequest

The request for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsRequest

ListDocumentsRequest.Builder

The request for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsRequest

ListDocumentsResponse

The response for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsResponse

ListDocumentsResponse.Builder

The response for Firestore.ListDocuments.

Protobuf type google.firestore.v1.ListDocumentsResponse

ListenRequest

A request for Firestore.Listen

Protobuf type google.firestore.v1.ListenRequest

ListenRequest.Builder

A request for Firestore.Listen

Protobuf type google.firestore.v1.ListenRequest

ListenResponse

The response for Firestore.Listen.

Protobuf type google.firestore.v1.ListenResponse

ListenResponse.Builder

The response for Firestore.Listen.

Protobuf type google.firestore.v1.ListenResponse

MapValue

A map value.

Protobuf type google.firestore.v1.MapValue

MapValue.Builder

A map value.

Protobuf type google.firestore.v1.MapValue

PartitionQueryRequest

The request for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryRequest

PartitionQueryRequest.Builder

The request for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryRequest

PartitionQueryResponse

The response for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryResponse

PartitionQueryResponse.Builder

The response for Firestore.PartitionQuery.

Protobuf type google.firestore.v1.PartitionQueryResponse

PlanSummary

Planning phase information for the query.

Protobuf type google.firestore.v1.PlanSummary

PlanSummary.Builder

Planning phase information for the query.

Protobuf type google.firestore.v1.PlanSummary

Precondition

A precondition on a document, used for conditional operations.

Protobuf type google.firestore.v1.Precondition

Precondition.Builder

A precondition on a document, used for conditional operations.

Protobuf type google.firestore.v1.Precondition

QueryProfileProto

QueryProto

RollbackRequest

The request for Firestore.Rollback.

Protobuf type google.firestore.v1.RollbackRequest

RollbackRequest.Builder

The request for Firestore.Rollback.

Protobuf type google.firestore.v1.RollbackRequest

RunAggregationQueryRequest

The request for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryRequest

RunAggregationQueryRequest.Builder

The request for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryRequest

RunAggregationQueryResponse

The response for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryResponse

RunAggregationQueryResponse.Builder

The response for Firestore.RunAggregationQuery.

Protobuf type google.firestore.v1.RunAggregationQueryResponse

RunQueryRequest

The request for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryRequest

RunQueryRequest.Builder

The request for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryRequest

RunQueryResponse

The response for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryResponse

RunQueryResponse.Builder

The response for Firestore.RunQuery.

Protobuf type google.firestore.v1.RunQueryResponse

StructuredAggregationQuery

Firestore query for running an aggregation over a StructuredQuery.

Protobuf type google.firestore.v1.StructuredAggregationQuery

StructuredAggregationQuery.Aggregation

Defines an aggregation that produces a single result.

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation

StructuredAggregationQuery.Aggregation.Avg

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.

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg

StructuredAggregationQuery.Aggregation.Avg.Builder

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.

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Avg

StructuredAggregationQuery.Aggregation.Builder

Defines an aggregation that produces a single result.

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation

StructuredAggregationQuery.Aggregation.Count

Count of documents that match the query.

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

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Count

StructuredAggregationQuery.Aggregation.Count.Builder

Count of documents that match the query.

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

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Count

StructuredAggregationQuery.Aggregation.Sum

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.

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum

StructuredAggregationQuery.Aggregation.Sum.Builder

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.

Protobuf type google.firestore.v1.StructuredAggregationQuery.Aggregation.Sum

StructuredAggregationQuery.Builder

Firestore query for running an aggregation over a StructuredQuery.

Protobuf type google.firestore.v1.StructuredAggregationQuery

StructuredQuery

A Firestore query.

The query stages are executed in the following order:

from
where
select
order_by + start_at + end_at
offset
limit

Protobuf type google.firestore.v1.StructuredQuery

StructuredQuery.Builder

A Firestore query.

The query stages are executed in the following order:

from
where
select
order_by + start_at + end_at
offset
limit

Protobuf type google.firestore.v1.StructuredQuery

StructuredQuery.CollectionSelector

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

Protobuf type google.firestore.v1.StructuredQuery.CollectionSelector

StructuredQuery.CollectionSelector.Builder

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

Protobuf type google.firestore.v1.StructuredQuery.CollectionSelector

StructuredQuery.CompositeFilter

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

Protobuf type google.firestore.v1.StructuredQuery.CompositeFilter

StructuredQuery.CompositeFilter.Builder

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

Protobuf type google.firestore.v1.StructuredQuery.CompositeFilter

StructuredQuery.FieldFilter

A filter on a specific field.

Protobuf type google.firestore.v1.StructuredQuery.FieldFilter

StructuredQuery.FieldFilter.Builder

A filter on a specific field.

Protobuf type google.firestore.v1.StructuredQuery.FieldFilter

StructuredQuery.FieldReference

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

Protobuf type google.firestore.v1.StructuredQuery.FieldReference

StructuredQuery.FieldReference.Builder

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

Protobuf type google.firestore.v1.StructuredQuery.FieldReference

StructuredQuery.Filter

A filter.

Protobuf type google.firestore.v1.StructuredQuery.Filter

StructuredQuery.Filter.Builder

A filter.

Protobuf type google.firestore.v1.StructuredQuery.Filter

StructuredQuery.Order

An order on a field.

Protobuf type google.firestore.v1.StructuredQuery.Order

StructuredQuery.Order.Builder

An order on a field.

Protobuf type google.firestore.v1.StructuredQuery.Order

StructuredQuery.Projection

The projection of document's fields to return.

Protobuf type google.firestore.v1.StructuredQuery.Projection

StructuredQuery.Projection.Builder

The projection of document's fields to return.

Protobuf type google.firestore.v1.StructuredQuery.Projection

StructuredQuery.UnaryFilter

A filter with a single operand.

Protobuf type google.firestore.v1.StructuredQuery.UnaryFilter

StructuredQuery.UnaryFilter.Builder

A filter with a single operand.

Protobuf type google.firestore.v1.StructuredQuery.UnaryFilter

Target

A specification of a set of documents to listen to.

Protobuf type google.firestore.v1.Target

Target.Builder

A specification of a set of documents to listen to.

Protobuf type google.firestore.v1.Target

Target.DocumentsTarget

A target specified by a set of documents names.

Protobuf type google.firestore.v1.Target.DocumentsTarget

Target.DocumentsTarget.Builder

A target specified by a set of documents names.

Protobuf type google.firestore.v1.Target.DocumentsTarget

Target.QueryTarget

A target specified by a query.

Protobuf type google.firestore.v1.Target.QueryTarget

Target.QueryTarget.Builder

A target specified by a query.

Protobuf type google.firestore.v1.Target.QueryTarget

TargetChange

Targets being watched have changed.

Protobuf type google.firestore.v1.TargetChange

TargetChange.Builder

Targets being watched have changed.

Protobuf type google.firestore.v1.TargetChange

TransactionOptions

Options for creating a new transaction.

Protobuf type google.firestore.v1.TransactionOptions

TransactionOptions.Builder

Options for creating a new transaction.

Protobuf type google.firestore.v1.TransactionOptions

TransactionOptions.ReadOnly

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

Protobuf type google.firestore.v1.TransactionOptions.ReadOnly

TransactionOptions.ReadOnly.Builder

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

Protobuf type google.firestore.v1.TransactionOptions.ReadOnly

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

Protobuf type google.firestore.v1.TransactionOptions.ReadWrite

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

Protobuf type google.firestore.v1.TransactionOptions.ReadWrite

UpdateDocumentRequest

The request for Firestore.UpdateDocument.

Protobuf type google.firestore.v1.UpdateDocumentRequest

UpdateDocumentRequest.Builder

The request for Firestore.UpdateDocument.

Protobuf type google.firestore.v1.UpdateDocumentRequest

Value

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

Protobuf type google.firestore.v1.Value

Value.Builder

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

Protobuf type google.firestore.v1.Value

Write

A write on a document.

Protobuf type google.firestore.v1.Write

Write.Builder

A write on a document.

Protobuf type google.firestore.v1.Write

WriteProto

WriteRequest

The request for 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.

Protobuf type google.firestore.v1.WriteRequest

WriteRequest.Builder

The request for 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.

Protobuf type google.firestore.v1.WriteRequest