Stay organized with collections Save and categorize content based on your preferences.
Describes the cause of the error with structured details.
Constructors ErrorInfo()Default constructor.
Post-condition: the reason()
, domain()
, and metadata()
fields are empty.
Constructor.
Parameters Name Descriptionreason
std::string
initializes the reason()
value.
domain
std::string
initializes the domain()
value.
metadata
std::unordered_map< std::string, std::string >
initializes the metadata()
value.
The reason of the error.
This is a constant value that identifies the proximate cause of the error. Error reasons are unique within a particular domain of errors. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9]
, which represents UPPER_SNAKE_CASE.
std::string const &
domain() const
The logical grouping to which the "reason" belongs.
The error domain is typically the registered service name of the tool or product that generates the error. Example: "pubsub.googleapis.com". If the error is generated by some common infrastructure, the error domain must be a globally unique value that identifies the infrastructure. For Google API infrastructure, the error domain is "googleapis.com".
For errors generated by the C++ client libraries the domain is gcloud-cpp
.
std::string const &
metadata() const
Additional structured details about this error.
Keys should match the regular expression [a-zA-Z0-9-_]
and be limited to 64 characters in length.
When identifying the current value of an exceeded limit, the units should be contained in the key, not the value. For example, if the client exceeds the number of instances that can be created in a single (batch) request return {"instanceLimitPerRequest": "100"}
rather than {"instanceLimit": "100/request"}
.
std::unordered_map< std::string, std::string > const &
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["The document provides versioned documentation for the `ErrorInfo` class in the Google Cloud C++ client library, ranging from version 2.10.1 up to the latest release candidate, 2.37.0-rc."],["The `ErrorInfo` class describes the cause of an error with structured details, as outlined by the Google Cloud API design guidelines."],["It has a default constructor where the fields are empty and a regular constructor which accepts a `reason`, `domain`, and `metadata` parameters to initialize its fields."],["Key functions include `reason()`, which returns a string identifying the cause of the error, `domain()`, which returns the logical grouping of the error, and `metadata()`, which returns additional structured details about the error."],["For errors generated by the C++ client libraries, the `domain` function will return `gcloud-cpp`."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4