Skip to content

Create a guide for RetrySettings #10586

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

Jump to bottom
Closed
alicejli opened this issue Mar 20, 2024 · 2 comments · Fixed by #10598
Closed

Create a guide for RetrySettings #10586

alicejli opened this issue Mar 20, 2024 · 2 comments · Fixed by #10598
Assignees
@lqiu96
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@alicejli
Copy link
Contributor

RetrySettings have been a source of customer confusion. We should create an external-facing guide to using and explaining RetrySettings within the GAPIC java client libraries
@alicejli alicejli added type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. labels Mar 20, 2024
@blakeli0 blakeli0 mentioned this issue Mar 21, 2024
Closed
@blakeli0
Copy link
Contributor

Currently we don't have any public guide other than Javadocs in RetrySettings, which could take customers a while to figure out. We should add a section for it to our README, similar to Long Running Operations section.

@lqiu96 lqiu96 mentioned this issue Mar 21, 2024
Merged
@lqiu96
Copy link
Contributor

lqiu96 commented Mar 21, 2024

@alicejli @blakeli0 Added a first draft for the README. Let me know if anything is unclear or if anything else should be added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lqiu96 lqiu96

Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: docs Improvement to the documentation for an API. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: Add Retry Guide googleapis/google-cloud-java
3 participants
@blakeli0 @lqiu96 @alicejli