Target(mapping=None, *, ignore_unknown_fields=False, **kwargs)A specification of a set of documents to listen to. .. attribute:: query
A target specified by a query.
Attributes | |
|---|---|
| Name | Description |
documents |
google.cloud.firestore_v1.types.Target.DocumentsTarget
A target specified by a set of document names. |
resume_token |
bytes
A resume token from a prior TargetChange][google.firestore.v1.TargetChange] for an
identical target.
Using a resume token with a different target is unsupported
and may fail.
|
read_time |
google.protobuf.timestamp_pb2.Timestamp
Start listening after a specific read_time.
The client must know the state of matching documents at this
time.
|
target_id |
int
The target ID that identifies the target on the stream. Must be a positive number and non- zero. |
once |
bool
If the target should be removed once it is current and consistent. |
Classes
DocumentsTarget
DocumentsTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)A target specified by a set of documents names. .. attribute:: documents
The names of the documents to retrieve. In the format:
projects/{project_id}/databases/{database_id}/documents/{document_path}.
The request will fail if any of the document is not a child
resource of the given database. Duplicate names will be
elided.
:type: Sequence[str]
QueryTarget
QueryTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)A target specified by a query. .. attribute:: parent
The parent resource name. In the format:
projects/{project_id}/databases/{database_id}/documents
or
projects/{project_id}/databases/{database_id}/documents/{document_path}.
For example:
projects/my-project/databases/my-database/documents or
projects/my-project/databases/my-database/documents/chatrooms/my-chatroom
:type: str