API documentation for firestore_v1.types package.
Classes
ArrayValue
An array value.
BatchGetDocumentsRequest
The request for
Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
BatchGetDocumentsResponse
The streamed response for
Firestore.BatchGetDocuments][google.firestore.v1.Firestore.BatchGetDocuments].
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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].
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. Must not exceed 1 MiB - 4 bytes.
DocumentChange
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.
DocumentDelete
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.
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.
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.
DocumentTransform
A transformation of a document.
ExistenceFilter
A digest of all the documents that match a given target.
GetDocumentRequest
The request for
Firestore.GetDocument][google.firestore.v1.Firestore.GetDocument].
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
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].
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListDocumentsResponse
The response for
Firestore.ListDocuments][google.firestore.v1.Firestore.ListDocuments].
ListenRequest
A request for
Firestore.Listen][google.firestore.v1.Firestore.Listen]
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ListenResponse
The response for
Firestore.Listen][google.firestore.v1.Firestore.Listen].
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
MapValue
A map value.
PartitionQueryRequest
The request for
Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PartitionQueryResponse
The response for
Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
Precondition
A precondition on a document, used for conditional operations.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RollbackRequest
The request for
Firestore.Rollback][google.firestore.v1.Firestore.Rollback].
RunQueryRequest
The request for
Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
RunQueryResponse
The response for
Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
StructuredQuery
A Firestore query.
Target
A specification of a set of documents to listen to.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
TargetChange
Targets being watched have changed.
TransactionOptions
Options for creating a new transaction.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UpdateDocumentRequest
The request for
Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].
Value
A message that can hold any of the supported value types.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Write
A write on a document.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
WriteRequest
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.
WriteResponse
The response for
Firestore.Write][google.firestore.v1.Firestore.Write].
WriteResult
The result of applying a write.