apierror

Documentation

Overview

Package apierror implements a wrapper error for parsing error details from API calls. Both HTTP & gRPC status errors are supported.

For examples of how to use APIError with client libraries please reference [Inspecting errors](https://pkg.go.dev/cloud.google.com/go#hdr-Inspecting_errors) in the client library documentation.

Index

• Variables
• type APIError
  • func FromError(err error) (*APIError, bool)
  • func ParseError(err error, wrap bool) (*APIError, bool)
  • func (a *APIError) Details() ErrDetails
  • func (a *APIError) Domain() string
  • func (a *APIError) Error() string
  • func (a *APIError) GRPCStatus() *status.Status
  • func (a *APIError) HTTPCode() int
  • func (a *APIError) Metadata() map[string]string
  • func (a *APIError) Reason() string
  • func (a *APIError) Unwrap() error
• type ErrDetails
  • func (e ErrDetails) ExtractProtoMessage(v proto.Message) error
  • func (e ErrDetails) String() string

Variables

var ErrMessageNotFound = errors.New("message not found")

ErrMessageNotFound is used to signal ExtractProtoMessage found no matching messages.

Types

type APIError

type APIError struct {
	// contains filtered or unexported fields
}

APIError wraps either a gRPC Status error or a HTTP googleapi.Error. It implements error and Status interfaces.

func FromError

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

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 (*APIError) Details

func (a *APIError) Details() ErrDetails

Details presents the error details of the APIError.

func (*APIError) Domain

func (a *APIError) Domain() string

Domain returns the domain in an ErrorInfo. If ErrorInfo is nil, it returns an empty string.

func (*APIError) Error

func (a *APIError) Error() string

Error returns a readable representation of the APIError.

func (*APIError) GRPCStatus

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 (*APIError) HTTPCode

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 (*APIError) Metadata

func (a *APIError) Metadata() map[string]string

Metadata returns the metadata in an ErrorInfo. If ErrorInfo is nil, it returns nil.

func (*APIError) Reason

func (a *APIError) Reason() string

Reason returns the reason in an ErrorInfo. If ErrorInfo is nil, it returns an empty string.

func (*APIError) Unwrap

func (a *APIError) Unwrap() error

Unwrap extracts the original error.

type ErrDetails

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{}
}

ErrDetails holds the google/rpc/error_details.proto messages.

func (ErrDetails) ExtractProtoMessage

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 (ErrDetails) String

func (e ErrDetails) String() string