Documentation ¶
Overview ¶
Package gdkerr provides an error type for GDK APIs.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DoNotWrap ¶
DoNotWrap reports whether an error should not be wrapped in the Error type from this package. It returns true if err is a retry error, a context error, io.EOF, or if it wraps one of those.
Types ¶
type Error ¶
type Error struct { // Code is the error code. Code ErrorCode // contains filtered or unexported fields }
An Error describes a Go CDK error.
func New ¶
New returns a new error with the given code, underlying error and message. Pass 1 for the call depth if New is called from the function raising the error; pass 2 if it is called from a helper function that was invoked by the original function; and so on.
func (*Error) FormatError ¶
FormatError formats the errots.
type ErrorCode ¶
type ErrorCode int
An ErrorCode describes the error's category.
const ( // OK is returned by the Code function on a nil error. It is not a valid // code for an error. OK ErrorCode = 0 // Unknown means that the error could not be categorized. Unknown ErrorCode = 1 // NotFound means that the resource was not found. NotFound ErrorCode = 2 // AlreadyExists means that the resource exists, but it should not. AlreadyExists ErrorCode = 3 // InvalidArguments means that a value given to a Go CDK API is incorrect. InvalidArgument ErrorCode = 4 // Internal means that something unexpected happened. Internal errors always indicate // bugs in the Go CDK (or possibly the underlying service). Internal ErrorCode = 5 // Unimplemented means that the feature is not implemented. Unimplemented ErrorCode = 6 // FailedPrecondition means that the system was in the wrong state. FailedPrecondition ErrorCode = 7 // PermissionDenied means that the caller does not have permission to execute the specified operation. PermissionDenied ErrorCode = 8 // ResourceExhausted means that some resource has been exhausted, typically because a service resource limit // has been reached. ResourceExhausted ErrorCode = 9 // Canceled means that the operation was canceled. Canceled ErrorCode = 10 // DeadlineExceeded means that The operation timed out. DeadlineExceeded ErrorCode = 11 )
func Code ¶
Code returns the ErrorCode of err if it, or some error it wraps, is an *Error. If err is context.Canceled or context.DeadlineExceeded, or wraps one of those errors, it returns the Canceled or DeadlineExceeded codes, respectively. If err is nil, it returns the special code OK. Otherwise, it returns Unknown.