errors

Documentation

Overview

Package errors provides detailed error types for api field validation.

Index

• func FromObject(obj runtime.Object) error
• func IsAlreadyExists(err error) bool
• func IsBadRequest(err error) bool
• func IsConflict(err error) bool
• func IsInvalid(err error) bool
• func IsNotFound(err error) bool
• func NewAlreadyExists(kind, name string) error
• func NewBadRequest(reason string) error
• func NewConflict(kind, name string, err error) error
• func NewInternalError(err error) error
• func NewInvalid(kind, name string, errs ValidationErrorList) error
• func NewNotFound(kind, name string) error
• func ValueOf(t ValidationErrorType) string
• type StatusError
  • func (e *StatusError) Error() string
  • func (e *StatusError) Status() api.Status
• type UnexpectedObjectError
  • func (u *UnexpectedObjectError) Error() string
• type ValidationError
  • func NewFieldDuplicate(field string, value interface{}) *ValidationError
  • func NewFieldForbidden(field string, value interface{}) *ValidationError
  • func NewFieldInvalid(field string, value interface{}, detail string) *ValidationError
  • func NewFieldNotFound(field string, value interface{}) *ValidationError
  • func NewFieldNotSupported(field string, value interface{}) *ValidationError
  • func NewFieldRequired(field string, value interface{}) *ValidationError
  • func (v *ValidationError) Error() string
• type ValidationErrorList
  • func (list ValidationErrorList) Prefix(prefix string) ValidationErrorList
  • func (list ValidationErrorList) PrefixIndex(index int) ValidationErrorList
• type ValidationErrorType

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 IsInvalid

func IsInvalid(err error) bool

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

func IsNotFound

func IsNotFound(err error) bool

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

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 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 ValidationErrorList) error

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

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 ValueOf

func ValueOf(t ValidationErrorType) string

ValueOf converts a ValidationErrorType into its corresponding error message.

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) 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'.

type ValidationError

type ValidationError struct {
	Type     ValidationErrorType
	Field    string
	BadValue interface{}
	Detail   string
}

ValidationError is an implementation of the 'error' interface, which represents an error of validation.

func NewFieldDuplicate

func NewFieldDuplicate(field string, value interface{}) *ValidationError

NewFieldDuplicate returns a *ValidationError indicating "duplicate value"

func NewFieldForbidden

func NewFieldForbidden(field string, value interface{}) *ValidationError

NewFieldForbidden returns a *ValidationError indicating "forbidden"

func NewFieldInvalid

func NewFieldInvalid(field string, value interface{}, detail string) *ValidationError

NewFieldInvalid returns a *ValidationError indicating "invalid value"

func NewFieldNotFound

func NewFieldNotFound(field string, value interface{}) *ValidationError

NewFieldNotFound returns a *ValidationError indicating "value not found"

func NewFieldNotSupported

func NewFieldNotSupported(field string, value interface{}) *ValidationError

NewFieldNotSupported returns a *ValidationError indicating "unsupported value"

func NewFieldRequired

func NewFieldRequired(field string, value interface{}) *ValidationError

NewFieldRequired returns a *ValidationError indicating "value required"

func (*ValidationError) Error

func (v *ValidationError) Error() string

type ValidationErrorList

type ValidationErrorList []error

func (ValidationErrorList) Prefix

func (list ValidationErrorList) Prefix(prefix string) ValidationErrorList

Prefix adds a prefix to the Field of every ValidationError in the list. Returns the list for convenience.

func (ValidationErrorList) PrefixIndex

func (list ValidationErrorList) PrefixIndex(index int) ValidationErrorList

PrefixIndex adds an index to the Field of every ValidationError in the list. Returns the list for convenience.

type ValidationErrorType

type ValidationErrorType string

ValidationErrorType is a machine readable value providing more detail about why a field is invalid. These values are expected to match 1-1 with CauseType in api/types.go.

const (
	// ValidationErrorTypeNotFound is used to report failure to find a requested value
	// (e.g. looking up an ID).
	ValidationErrorTypeNotFound ValidationErrorType = "FieldValueNotFound"
	// ValidationErrorTypeRequired is used to report required values that are not
	// provided (e.g. empty strings, null values, or empty arrays).
	ValidationErrorTypeRequired ValidationErrorType = "FieldValueRequired"
	// ValidationErrorTypeDuplicate is used to report collisions of values that must be
	// unique (e.g. unique IDs).
	ValidationErrorTypeDuplicate ValidationErrorType = "FieldValueDuplicate"
	// ValidationErrorTypeInvalid is used to report malformed values (e.g. failed regex
	// match).
	ValidationErrorTypeInvalid ValidationErrorType = "FieldValueInvalid"
	// ValidationErrorTypeNotSupported is used to report valid (as per formatting rules)
	// values that can not be handled (e.g. an enumerated string).
	ValidationErrorTypeNotSupported ValidationErrorType = "FieldValueNotSupported"
	// ValidationErrorTypeForbidden is used to report valid (as per formatting rules)
	// values which would be accepted by some api instances, but which would invoke behavior
	// not permitted by this api instance (such as due to stricter security policy).
	ValidationErrorTypeForbidden ValidationErrorType = "FieldValueForbidden"
)

TODO: These values are duplicated in api/types.go, but there's a circular dep. Fix it.