apierror

Documentation

Index

• type Error
  • func (r *Error) DumpRequest(body bool) []byte
  • func (r *Error) DumpResponse(body bool) []byte
  • func (r *Error) Error() string
  • func (r *Error) UnmarshalJSON(data []byte) (err error)

Types

type Error

type Error struct {
	// The status code, which should be an enum value of
	// [google.rpc.Code][google.rpc.Code].
	Code shared.ErrorCode `json:"code"`
	// A developer-facing error message, which should be in English. Any user-facing
	// error message should be localized and sent in the
	// [google.rpc.Status.details][google.rpc.Status.details] field, or localized by
	// the client.
	Message     string                 `json:"message"`
	ExtraFields map[string]interface{} `json:"-,extras"`
	JSON        errorJSON              `json:"-"`
	StatusCode  int
	Request     *http.Request
	Response    *http.Response
}

Error represents an error that originates from the API, i.e. when a request is made and the API returns a response with a HTTP status code. Other errors are not wrapped by this SDK.

func (*Error) DumpRequest

func (r *Error) DumpRequest(body bool) []byte

func (*Error) DumpResponse

func (r *Error) DumpResponse(body bool) []byte

func (*Error) Error

func (r *Error) Error() string

func (*Error) UnmarshalJSON

func (r *Error) UnmarshalJSON(data []byte) (err error)