ErrMessageNotFound is used to signal ExtractProtoMessage found no matching messages.
var ErrMessageNotFound = errors.New("message not found")
APIError wraps either a gRPC Status error or a HTTP googleapi.Error. It implements error and Status interfaces.
type APIError struct {
// contains filtered or unexported fields
}
func FromError(err error) (*APIError, bool)
FromError parses a Status error or a googleapi.Error and builds an APIError, wrapping the provided error in the new APIError. It returns false if neither Status nor googleapi.Error can be parsed.
func ParseError(err error, wrap bool) (*APIError, bool)
ParseError parses a Status error or a googleapi.Error and builds an APIError. If wrap is true, it wraps the error in the new APIError. It returns false if neither Status nor googleapi.Error can be parsed.
func (a *APIError) Details() ErrDetails
Details presents the error details of the APIError.
func (a *APIError) Domain() string
Domain returns the domain in an ErrorInfo. If ErrorInfo is nil, it returns an empty string.
func (a *APIError) Error() string
Error returns a readable representation of the APIError.
func (a *APIError) GRPCStatus() *status.Status
GRPCStatus extracts the underlying gRPC Status error. This method is necessary to fulfill the interface described in https://pkg.go.dev/google.golang.org/grpc/status#FromError.
func (a *APIError) HTTPCode() int
HTTPCode returns the underlying HTTP response status code. This method returns `-1` if the underlying error is a google.golang.org/grpc/status.Status. To check gRPC error codes use google.golang.org/grpc/status.Code.
func (a *APIError) Metadata() map[string]string
Metadata returns the metadata in an ErrorInfo. If ErrorInfo is nil, it returns nil.
func (a *APIError) Reason() string
Reason returns the reason in an ErrorInfo. If ErrorInfo is nil, it returns an empty string.
func (a *APIError) Unwrap() error
Unwrap extracts the original error.
ErrDetails holds the google/rpc/error_details.proto messages.
type ErrDetails struct {
ErrorInfo *errdetails.ErrorInfo
BadRequest *errdetails.BadRequest
PreconditionFailure *errdetails.PreconditionFailure
QuotaFailure *errdetails.QuotaFailure
RetryInfo *errdetails.RetryInfo
ResourceInfo *errdetails.ResourceInfo
RequestInfo *errdetails.RequestInfo
DebugInfo *errdetails.DebugInfo
Help *errdetails.Help
LocalizedMessage *errdetails.LocalizedMessage
// Unknown stores unidentifiable error details.
Unknown []interface{}
}
func (e ErrDetails) ExtractProtoMessage(v proto.Message) error
ExtractProtoMessage provides a mechanism for extracting protobuf messages from the Unknown error details. If ExtractProtoMessage finds an unknown message of the same type, the content of the message is copied to the provided message.
ExtractProtoMessage will return ErrMessageNotFound if there are no message matching the protocol buffer type of the provided message.
func (e ErrDetails) String() string
| Name | Synopsis |
|---|---|
| .. | |