import "k8s.io/apimachinery/pkg/api/errors"
Package errors provides detailed error types for api field validation.
const (
// StatusTooManyRequests means the server experienced too many requests within a
// given window and that the client must wait to perform the action again.
// DEPRECATED: please use http.StatusTooManyRequests, this will be removed in
// the future version.
StatusTooManyRequests = http.StatusTooManyRequests
)FromObject generates an StatusError from an metav1.Status, if that is the type of obj; otherwise, returns an UnexpecteObjectError.
IsAlreadyExists determines if the err is an error which indicates that a specified resource already exists.
IsBadRequest determines if err is an error which indicates that the request is invalid.
IsConflict determines if the err is an error which indicates the provided update conflicts.
IsForbidden determines if err is an error which indicates that the request is forbidden and cannot be completed as requested.
IsGone is true if the error indicates the requested resource is no longer available.
IsInternalError determines if err is an error which indicates an internal server error.
IsInvalid determines if the err is an error which indicates the provided resource is not valid.
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.
IsNotAcceptable determines if err is an error which indicates that the request failed due to an invalid Accept header
IsNotFound returns true if the specified error was created by NewNotFound.
IsRequestEntityTooLargeError determines if err is an error which indicates the request entity is too large.
IsResourceExpired is true if the error indicates the resource has expired and the current action is no longer possible.
IsServerTimeout determines if err is an error which indicates that the request needs to be retried by the client.
IsServiceUnavailable is true if the error indicates the underlying service is no longer available.
IsTimeout determines if err is an error which indicates that request times out due to long processing.
IsTooManyRequests determines if err is an error which indicates that there are too many requests that the server cannot handle.
IsUnauthorized determines if err is an error which indicates that the request is unauthorized and requires authentication by the user.
IsUnexpectedObjectError determines if err is due to an unexpected object from the master.
IsUnexpectedServerError returns true if the server response was not in the expected API format, and may be the result of another HTTP actor.
IsUnsupportedMediaType determines if err is an error which indicates that the request failed due to an invalid Content-Type header
func ReasonForError(err error) metav1.StatusReason
ReasonForError returns the HTTP status for a particular error.
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. It does not address whether the error *should* be retried, since some errors (like a 3xx) may request delay without retry.
APIStatus is exposed by errors that can be converted to an api.Status object for finer grained details.
type ErrorReporter struct {
// contains filtered or unexported fields
}ErrorReporter converts generic errors into runtime.Object errors without requiring the caller to take a dependency on meta/v1 (where Status lives). This prevents circular dependencies in core watch code.
func NewClientErrorReporter(code int, verb string, reason string) *ErrorReporter
NewClientErrorReporter will respond with valid v1.Status objects that report unexpected server responses. Primarily used by watch to report errors when we attempt to decode a response from the server and it is not in the form we expect. Because watch is a dependency of the core api, we can't return meta/v1.Status in that package and so much inject this interface to convert a generic error as appropriate. The reason is passed as a unique status cause on the returned status, otherwise the generic "ClientError" is returned.
func (r *ErrorReporter) AsObject(err error) runtime.Object
AsObject returns a valid error runtime.Object (a v1.Status) for the given error, using the code and verb of the reporter type. The error is set to indicate that this was an unexpected server response.
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 NewAlreadyExists(qualifiedResource schema.GroupResource, name string) *StatusError
NewAlreadyExists returns an error indicating the item requested exists by that identifier.
func NewApplyConflict(causes []metav1.StatusCause, message string) *StatusError
NewApplyConflict returns an error including details on the requests apply conflicts
func NewBadRequest(reason string) *StatusError
NewBadRequest creates an error that indicates that the request is invalid and can not be processed.
func NewConflict(qualifiedResource schema.GroupResource, name string, err error) *StatusError
NewConflict returns an error indicating the item can't be updated as provided.
func NewForbidden(qualifiedResource schema.GroupResource, name string, err error) *StatusError
NewForbidden returns an error indicating the requested action was forbidden
func NewGenericServerResponse(code int, verb string, qualifiedResource schema.GroupResource, name, serverMessage string, retryAfterSeconds int, isUnexpectedResponse bool) *StatusError
NewGenericServerResponse returns a new error for server responses that are not in a recognizable form.
func NewGone(message string) *StatusError
NewGone returns an error indicating the item no longer available at the server and no forwarding address is known.
func NewInternalError(err error) *StatusError
NewInternalError returns an error indicating the item is invalid and cannot be processed.
NewInvalid returns an error indicating the item is invalid and cannot be processed.
func NewMethodNotSupported(qualifiedResource schema.GroupResource, action string) *StatusError
NewMethodNotSupported returns an error indicating the requested action is not supported on this kind.
func NewNotFound(qualifiedResource schema.GroupResource, name string) *StatusError
NewNotFound returns a new error which indicates that the resource of the kind and the name was not found.
func NewRequestEntityTooLargeError(message string) *StatusError
NewRequestEntityTooLargeError returns an error indicating that the request entity was too large.
func NewResourceExpired(message string) *StatusError
NewResourceExpired creates an error that indicates that the requested resource content has expired from the server (usually due to a resourceVersion that is too old).
func NewServerTimeout(qualifiedResource schema.GroupResource, operation string, retryAfterSeconds int) *StatusError
NewServerTimeout returns an error indicating the requested action could not be completed due to a transient error, and the client should try again.
func NewServerTimeoutForKind(qualifiedKind schema.GroupKind, operation string, retryAfterSeconds int) *StatusError
NewServerTimeoutForKind should not exist. Server timeouts happen when accessing resources, the Kind is just what we happened to be looking at when the request failed. This delegates to keep code sane, but we should work towards removing this.
func NewServiceUnavailable(reason string) *StatusError
NewServiceUnavailable creates an error that indicates that the requested service is unavailable.
func NewTimeoutError(message string, retryAfterSeconds int) *StatusError
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 NewTooManyRequests(message string, retryAfterSeconds int) *StatusError
NewTooManyRequests creates an error that indicates that the client must try again later because the specified endpoint is not accepting requests. More specific details should be provided if client should know why the failure was limited4.
func NewTooManyRequestsError(message string) *StatusError
NewTooManyRequestsError returns an error indicating that the request was rejected because the server has received too many requests. Client should wait and retry. But if the request is perishable, then the client should not retry the request.
func NewUnauthorized(reason string) *StatusError
NewUnauthorized returns an error indicating the client is not authorized to perform the requested action.
func (e *StatusError) DebugError() (string, []interface{})
DebugError reports extended info about the error to debug output.
func (e *StatusError) Error() string
Error implements the Error interface.
func (e *StatusError) Status() metav1.Status
Status allows access to e's status without having to know the detailed workings of StatusError.
UnexpectedObjectError can be returned by FromObject if it's passed a non-status object.
func (u *UnexpectedObjectError) Error() string
Error returns an error message describing 'u'.
Package errors imports 9 packages (graph) and is imported by 5683 packages. Updated 2019-08-20. Refresh now. Tools for package owners.