API documentation for firestore_v1.types package.
Classes
ArrayValue
An array value. .. attribute:: values
Values in the array.
:type: Sequence[google.cloud.firestore_v1.types.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].
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. .. attribute:: values
The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
:type: Sequence[google.cloud.firestore_v1.types.Value]
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. .. attribute:: document
The name of the document to transform.
:type: str
ExistenceFilter
A digest of all the documents that match a given target. .. attribute:: target_id
The target ID to which this filter applies.
:type: int
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. .. attribute:: fields
The map's fields.
The map keys represent field names. Field names matching the
regular expression __.*__ are reserved. Reserved field
names are forbidden except in certain documented contexts.
The map keys, represented as UTF-8, must not exceed 1,500
bytes and cannot be empty.
:type: Sequence[google.cloud.firestore_v1.types.MapValue.FieldsEntry]
PartitionQueryRequest
The request for
Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
PartitionQueryResponse
The response for
Firestore.PartitionQuery][google.firestore.v1.Firestore.PartitionQuery].
Precondition
A precondition on a document, used for conditional operations.
RollbackRequest
The request for
Firestore.Rollback][google.firestore.v1.Firestore.Rollback].
RunQueryRequest
The request for
Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
RunQueryResponse
The response for
Firestore.RunQuery][google.firestore.v1.Firestore.RunQuery].
StructuredQuery
A Firestore query. .. attribute:: select
The projection to return.
:type: google.cloud.firestore_v1.types.StructuredQuery.Projection
Target
A specification of a set of documents to listen to. .. attribute:: query
A target specified by a query.
TargetChange
Targets being watched have changed. .. attribute:: target_change_type
The type of change that occurred.
:type: google.cloud.firestore_v1.types.TargetChange.TargetChangeType
TransactionOptions
Options for creating a new transaction. .. attribute:: read_only
The transaction can only be used for read operations.
:type: google.cloud.firestore_v1.types.TransactionOptions.ReadOnly
UpdateDocumentRequest
The request for
Firestore.UpdateDocument][google.firestore.v1.Firestore.UpdateDocument].
Value
A message that can hold any of the supported value types. .. attribute:: null_value
A null value.
:type: google.protobuf.struct_pb2.NullValue
Write
A write on a document. .. attribute:: update
A document to write.
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. .. attribute:: update_time
The last update time of the document after applying the
write. Not set after a delete.
If the write did not actually change the document, this will be the previous update_time.
:type: google.protobuf.timestamp_pb2.Timestamp