Skip to content

Commit

Permalink
docs: clarify docstring in RunQueryRequest/RunQueryResponse (#544)
Browse files Browse the repository at this point in the history
* fix: change REST binding for ListDocuments to support root collection

PiperOrigin-RevId: 432504691

Source-Link: googleapis/googleapis@3db3087

Source-Link: googleapis/googleapis-gen@80f0375
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiODBmMDM3NWExYTgyNDYwNTMyNDIyZTUwNGE0MWVmMmEzZTJmNzJlMSJ9

* 🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
  • Loading branch information
gcf-owl-bot[bot] and gcf-owl-bot[bot] authored Mar 4, 2022
1 parent c214732 commit d17febb
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 4 deletions.
3 changes: 2 additions & 1 deletion google/cloud/firestore_v1/types/common.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,8 @@ class Precondition(proto.Message):
This field is a member of `oneof`_ ``condition_type``.
update_time (google.protobuf.timestamp_pb2.Timestamp):
When set, the target document must exist and
have been last updated at that time.
have been last updated at that time. Timestamp
must be microsecond aligned.
This field is a member of `oneof`_ ``condition_type``.
"""
Expand Down
9 changes: 6 additions & 3 deletions google/cloud/firestore_v1/types/firestore.py
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,10 @@ class RunQueryRequest(proto.Message):
This field is a member of `oneof`_ ``query_type``.
transaction (bytes):
Reads documents in a transaction.
Run the query within an already active
transaction.
The value here is the opaque transaction ID to
execute the query in.
This field is a member of `oneof`_ ``consistency_selector``.
new_transaction (google.cloud.firestore_v1.types.TransactionOptions):
Expand Down Expand Up @@ -559,8 +562,8 @@ class RunQueryResponse(proto.Message):
was set in the request. If set, no other fields will be set
in this response.
document (google.cloud.firestore_v1.types.Document):
A query result.
Not set when reporting partial progress.
A query result, not set when reporting
partial progress.
read_time (google.protobuf.timestamp_pb2.Timestamp):
The time at which the document was read. This may be
monotonically increasing; in this case, the previous
Expand Down

0 comments on commit d17febb

Please sign in to comment.