ugrpc::Help Struct Reference

#include <userver/ugrpc/rich_status.hpp>

Detailed Description

Provides links to documentation and help resources.

See also

https://google.aip.dev/193

https:///github.com/googleapis/googleapis/blob/master/google/rpc/error_details.proto

https://nda.ya.ru/t/PmNiceWp7NKDXb

ugrpc::RichStatus

Use this detail to direct users to relevant documentation, FAQs, or support resources that can help them resolve the error.

Example usage:

    ugrpc::RichStatus status{
        grpc::StatusCode::PERMISSION_DENIED,
        "Access denied",
        ugrpc::Help{{
            {"API Documentation", "https://example.com/docs/api"},
            {"Authentication Guide", "https://example.com/docs/auth"},
            {"Support", "https://example.com/support"},
        }},
    };

Definition at line 332 of file rich_status.hpp.

Public Member Functions
google::rpc::Help	ToGoogleErrorDetail () const &
google::rpc::Help	ToGoogleErrorDetail () &&

Static Public Member Functions
static std::optional< Help >	TryUnpack (const google::protobuf::Any &any)

Public Attributes
std::vector< HelpLink >	links
	The list of help links.

Member Data Documentation

links

std::vector<HelpLink> ugrpc::Help::links

The list of help links.

Definition at line 334 of file rich_status.hpp.

---

The documentation for this struct was generated from the following file:

• userver/ugrpc/rich_status.hpp