Target(mapping=None, *, ignore_unknown_fields=False, **kwargs)
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
Attributes
Name | Description |
query |
google.cloud.firestore_v1.types.Target.QueryTarget
A target specified by a query. This field is a member of `oneof`_ ``target_type``. |
documents |
google.cloud.firestore_v1.types.Target.DocumentsTarget
A target specified by a set of document names. This field is a member of `oneof`_ ``target_type``. |
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. This field is a member of `oneof`_ ``resume_type``. |
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. This field is a member of `oneof`_ ``resume_type``. |
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. |
Inheritance
builtins.object > proto.message.Message > TargetClasses
DocumentsTarget
DocumentsTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A target specified by a set of documents names.
QueryTarget
QueryTarget(mapping=None, *, ignore_unknown_fields=False, **kwargs)
A target specified by a query.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields