errors

Documentation

Overview

Package errors provides detailed error types for api field validation.

Index

• Constants
• func FromObject(obj runtime.Object) error
• func IsAlreadyExists(err error) bool
• func IsBadRequest(err error) bool
• func IsConflict(err error) bool
• func IsForbidden(err error) bool
• func IsInvalid(err error) bool
• func IsMethodNotSupported(err error) bool
• func IsNotFound(err error) bool
• func IsServerTimeout(err error) bool
• func IsUnauthorized(err error) bool
• func IsUnexpectedObjectError(err error) bool
• func IsUnexpectedServerError(err error) bool
• func NewAlreadyExists(kind, name string) error
• func NewBadRequest(reason string) error
• func NewConflict(kind, name string, err error) error
• func NewForbidden(kind, name string, err error) error
• func NewGenericServerResponse(code int, verb, kind, name, serverMessage string, retryAfterSeconds int, ...) error
• func NewInternalError(err error) error
• func NewInvalid(kind, name string, errs fielderrors.ValidationErrorList) error
• func NewMethodNotSupported(kind, action string) error
• func NewNotFound(kind, name string) error
• func NewServerTimeout(kind, operation string, retryAfterSeconds int) error
• func NewServiceUnavailable(reason string) error
• func NewTimeoutError(message string, retryAfterSeconds int) error
• func NewUnauthorized(reason string) error
• func SuggestsClientDelay(err error) (int, bool)
• type StatusError
  • func (e *StatusError) DebugError() (string, []interface{})
  • func (e *StatusError) Error() string
  • func (e *StatusError) Status() api.Status
• type UnexpectedObjectError
  • func (u *UnexpectedObjectError) Error() string

Constants

const (
	StatusUnprocessableEntity = 422
	StatusTooManyRequests     = 429
	// HTTP recommendations are for servers to define 5xx error codes
	// for scenarios not covered by behavior. In this case, ServerTimeout
	// is an indication that a transient server error has occurred and the
	// client *should* retry, with an optional Retry-After header to specify
	// the back off window.
	StatusServerTimeout = 504
)

HTTP Status codes not in the golang http package.

Functions

func FromObject

func FromObject(obj runtime.Object) error

FromObject generates an StatusError from an api.Status, if that is the type of obj; otherwise, returns an UnexpecteObjectError.

func IsAlreadyExists

func IsAlreadyExists(err error) bool

IsAlreadyExists determines if the err is an error which indicates that a specified resource already exists.

func IsBadRequest

func IsBadRequest(err error) bool

IsBadRequest determines if err is an error which indicates that the request is invalid.

func IsConflict

func IsConflict(err error) bool

IsConflict determines if the err is an error which indicates the provided update conflicts.

func IsForbidden

func IsForbidden(err error) bool

IsForbidden determines if err is an error which indicates that the request is forbidden and cannot be completed as requested.

func IsInvalid

func IsInvalid(err error) bool

IsInvalid determines if the err is an error which indicates the provided resource is not valid.

func IsMethodNotSupported

func IsMethodNotSupported(err error) bool

IsMethodNotSupported determines if the err is an error which indicates the provided action could not be performed because it is not supported by the server.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound returns true if the specified error was created by NewNotFound.

func IsServerTimeout

func IsServerTimeout(err error) bool

IsServerTimeout determines if err is an error which indicates that the request needs to be retried by the client.

func IsUnauthorized

func IsUnauthorized(err error) bool

IsUnauthorized determines if err is an error which indicates that the request is unauthorized and requires authentication by the user.

func IsUnexpectedObjectError

func IsUnexpectedObjectError(err error) bool

IsUnexpectedObjectError determines if err is due to an unexpected object from the master.

func IsUnexpectedServerError

func IsUnexpectedServerError(err error) bool

IsUnexpectedServerError returns true if the server response was not in the expected API format, and may be the result of another HTTP actor.

func NewAlreadyExists

func NewAlreadyExists(kind, name string) error

NewAlreadyExists returns an error indicating the item requested exists by that identifier.

func NewBadRequest

func NewBadRequest(reason string) error

NewBadRequest creates an error that indicates that the request is invalid and can not be processed.

func NewConflict

func NewConflict(kind, name string, err error) error

NewConflict returns an error indicating the item can't be updated as provided.

func NewForbidden

func NewForbidden(kind, name string, err error) error

NewForbidden returns an error indicating the requested action was forbidden

func NewGenericServerResponse

func NewGenericServerResponse(code int, verb, kind, name, serverMessage string, retryAfterSeconds int, isUnexpectedResponse bool) error

NewGenericServerResponse returns a new error for server responses that are not in a recognizable form.

func NewInternalError

func NewInternalError(err error) error

NewInternalError returns an error indicating the item is invalid and cannot be processed.

func NewInvalid

func NewInvalid(kind, name string, errs fielderrors.ValidationErrorList) error

NewInvalid returns an error indicating the item is invalid and cannot be processed.

func NewMethodNotSupported

func NewMethodNotSupported(kind, action string) error

NewMethodNotSupported returns an error indicating the requested action is not supported on this kind.

func NewNotFound

func NewNotFound(kind, name string) error

NewNotFound returns a new error which indicates that the resource of the kind and the name was not found.

func NewServerTimeout

func NewServerTimeout(kind, operation string, retryAfterSeconds int) error

NewServerTimeout returns an error indicating the requested action could not be completed due to a transient error, and the client should try again.

func NewServiceUnavailable

func NewServiceUnavailable(reason string) error

NewServiceUnavailable creates an error that indicates that the requested service is unavailable.

func NewTimeoutError

func NewTimeoutError(message string, retryAfterSeconds int) error

NewTimeoutError returns an error indicating that a timeout occurred before the request could be completed. Clients may retry, but the operation may still complete.

func NewUnauthorized

func NewUnauthorized(reason string) error

NewUnauthorized returns an error indicating the client is not authorized to perform the requested action.

func SuggestsClientDelay

func SuggestsClientDelay(err error) (int, bool)

SuggestsClientDelay returns true if this error suggests a client delay as well as the suggested seconds to wait, or false if the error does not imply a wait.

Types

type StatusError

type StatusError struct {
	ErrStatus api.Status
}

StatusError is an error intended for consumption by a REST API server; it can also be reconstructed by clients from a REST response. Public to allow easy type switches.

func (*StatusError) DebugError

func (e *StatusError) DebugError() (string, []interface{})

DebugError reports extended info about the error to debug output.

func (*StatusError) Error

func (e *StatusError) Error() string

Error implements the Error interface.

func (*StatusError) Status

func (e *StatusError) Status() api.Status

Status allows access to e's status without having to know the detailed workings of StatusError. Used by pkg/apiserver.

type UnexpectedObjectError

type UnexpectedObjectError struct {
	Object runtime.Object
}

UnexpectedObjectError can be returned by FromObject if it's passed a non-status object.

func (*UnexpectedObjectError) Error

func (u *UnexpectedObjectError) Error() string

Error returns an error message describing 'u'.