docs(user-guide): how to examine error details#1685
Merged
coryan merged 3 commits intogoogleapis:mainfrom Apr 2, 2025
Merged
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1685 +/- ##
=======================================
Coverage 95.94% 95.94%
=======================================
Files 47 47
Lines 1850 1850
=======================================
Hits 1775 1775
Misses 75 75 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
dbolduc
approved these changes
Apr 2, 2025
guide/src/examine_error_details.md
Outdated
| {{#include ../samples/src/examine_error_details.rs:examine-error-details-service-error}} | ||
| ``` | ||
|
|
||
| The client libraries return a the [`StatusDetails`] enum with the different |
guide/src/examine_error_details.md
Outdated
| `StatusDetails`, such as [`QuotaFailure`] may be useful at runtime to throttle | ||
| an application. | ||
|
|
||
| ### Expected Output |
| Typically the output from the error details will look like so: | ||
|
|
||
| ```text | ||
| status.code=400, status.message=One of content, or gcs_content_uri must be set., status.status=Some("INVALID_ARGUMENT") |
Member
There was a problem hiding this comment.
comment: if we normalize the status codes, we will need to update this text
| - [How to initialize a client](initialize_a_client.md) | ||
| - [Configuring retry policies](configuring_retry_policies.md) | ||
| - [Error handling](error_handling.md) | ||
| - [Examine error details](examine_error_details.md) |
Member
There was a problem hiding this comment.
comment: we might want to organize these into sections, but let's defer that until we have more guides
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of the work for #574