Module v1

Modules

batch_get_documents_request

Nested message and enum types in BatchGetDocumentsRequest.

batch_get_documents_response

Nested message and enum types in BatchGetDocumentsResponse.

document_transform

Nested message and enum types in DocumentTransform.

firestore_client

Generated client implementations.

get_document_request

Nested message and enum types in GetDocumentRequest.

list_collection_ids_request

Nested message and enum types in ListCollectionIdsRequest.

list_documents_request

Nested message and enum types in ListDocumentsRequest.

listen_request

Nested message and enum types in ListenRequest.

listen_response

Nested message and enum types in ListenResponse.

partition_query_request

Nested message and enum types in PartitionQueryRequest.

precondition

Nested message and enum types in Precondition.

run_aggregation_query_request

Nested message and enum types in RunAggregationQueryRequest.

run_query_request

Nested message and enum types in RunQueryRequest.

run_query_response

Nested message and enum types in RunQueryResponse.

structured_aggregation_query

Nested message and enum types in StructuredAggregationQuery.

structured_query

Nested message and enum types in StructuredQuery.

target

Nested message and enum types in Target.

target_change

Nested message and enum types in TargetChange.

transaction_options

Nested message and enum types in TransactionOptions.

value

Nested message and enum types in Value.

write

Nested message and enum types in Write.

Structs

AggregationResult

The result of a single bucket from a Firestore aggregation query.

ArrayValue

An array value.

BatchGetDocumentsRequest

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

BatchGetDocumentsResponse

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

BatchWriteRequest

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

BatchWriteResponse

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

BeginTransactionRequest

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

BeginTransactionResponse

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

BitSequence

A sequence of bits, encoded in a byte array.

BloomFilter

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

CommitRequest

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

CommitResponse

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

CreateDocumentRequest

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

Cursor

A position in a query result set.

DeleteDocumentRequest

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

Document

A Firestore document.

DocumentChange

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

DocumentDelete

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

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][google.firestore.v1.Document], and takes in account the dynamic nature of [Value][google.firestore.v1.Value].

DocumentRemove

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

DocumentTransform

A transformation of a document.

ExecutionStats

Execution statistics for the query.

ExistenceFilter

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

ExplainMetrics

Explain metrics for the query.

ExplainOptions

Explain options for the query.

GetDocumentRequest

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

ListCollectionIdsRequest

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

ListCollectionIdsResponse

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

ListDocumentsRequest

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

ListDocumentsResponse

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

ListenRequest

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

ListenResponse

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

MapValue

A map value.

PartitionQueryRequest

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

PartitionQueryResponse

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

PlanSummary

Planning phase information for the query.

Precondition

A precondition on a document, used for conditional operations.

RollbackRequest

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

RunAggregationQueryRequest

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

RunAggregationQueryResponse

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

RunQueryRequest

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

RunQueryResponse

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

StructuredAggregationQuery

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

StructuredQuery

A Firestore query.

Target

A specification of a set of documents to listen to.

TargetChange

Targets being watched have changed.

TransactionOptions

Options for creating a new transaction.

UpdateDocumentRequest

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

Value

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

Write

A write on a document.

WriteRequest

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

WriteResponse

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

WriteResult

The result of applying a write.