Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: clarify docstring in RunQueryRequest/RunQueryResponse #544

Merged
merged 2 commits into from
Mar 4, 2022
Merged

docs: clarify docstring in RunQueryRequest/RunQueryResponse #544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ca1217
fix: change REST binding for ListDocuments to support root collection
gcf-owl-bot[bot] Mar 4, 2022
cfd453f
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Mar 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion google/cloud/firestore_v1/types/common.py
View file
Open in desktop
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
View file
Open in desktop
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