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.

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: add clarification to batch module #1045

Merged
merged 5 commits into from
Jun 6, 2023

Conversation

cojenco
Copy link
Contributor

@cojenco cojenco commented May 19, 2023

This PR is intended to:

  • Clarify limited Batch support in the python client
  • Provide guidance on compatible use cases with batch requests
  • Add comment in batch sample

The current batch design does not support library methods whose return values depend on the response payload. Adding such support would be a huge undertaking, and is not prioritized at the moment. Incompatible use cases include but are not limited to:

  • error handling (i.e. blob.exists() or on_error callable in bucket.delete_blobs())
  • return value is extracted from the response payload (blob.rewrite() returns a 3-tuple, (rewrite_token, bytes_rewritten, object_size))

@product-auto-label product-auto-label bot added size: s Pull request size is small. api: storage Issues related to the googleapis/python-storage API. labels May 19, 2023
@cojenco cojenco added the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 6, 2023
@gcf-owl-bot gcf-owl-bot bot removed the owlbot:run Add this label to trigger the Owlbot post processor. label Jun 6, 2023
@cojenco cojenco marked this pull request as ready for review June 6, 2023 22:03
@cojenco cojenco requested review from a team as code owners June 6, 2023 22:03
@cojenco cojenco requested a review from parthea June 6, 2023 22:03
@cojenco cojenco merged commit 11f6024 into googleapis:main Jun 6, 2023
13 checks passed
@cojenco cojenco deleted the update-batch-docs branch November 16, 2023 22:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/python-storage API. size: s Pull request size is small.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants