status

Documentation

Index

• func Errorf(errorType Type, format string, a ...interface{}) error
• func NewAccountNotFoundError(accountKey string) error
• func NewAdminPermissionError() error
• func NewGetAccountError(err error) error
• func NewGetAccountFromStoreError(err error) error
• func NewGetUserFromStoreError() error
• func NewGroupNotFoundError(groupID string) error
• func NewInvalidKeyIDError() error
• func NewNameServerGroupNotFoundError(nsGroupID string) error
• func NewNetworkNotFoundError(networkID string) error
• func NewNetworkResourceNotFoundError(resourceID string) error
• func NewNetworkRouterNotFoundError(routerID string) error
• func NewPeerLoginExpiredError() error
• func NewPeerNotFoundError(peerKey string) error
• func NewPeerNotRegisteredError() error
• func NewPermissionDeniedError() error
• func NewPermissionValidationError(err error) error
• func NewPolicyNotFoundError(policyID string) error
• func NewPostureChecksNotFoundError(postureChecksID string) error
• func NewResourceNotPartOfNetworkError(resourceID, networkID string) error
• func NewRouterNotPartOfNetworkError(routerID, networkID string) error
• func NewSetupKeyNotFoundError(setupKeyID string) error
• func NewUserNotFoundError(userKey string) error
• func NewUserNotPartOfAccountError() error
• type Error
  • func FromError(err error) (s *Error, ok bool)
  • func (e *Error) Error() string
  • func (e *Error) Type() Type
• type Type

Functions

func Errorf

func Errorf(errorType Type, format string, a ...interface{}) error

Errorf returns Error(ErrorType, fmt.Sprintf(format, a...)).

func NewAccountNotFoundError

func NewAccountNotFoundError(accountKey string) error

NewAccountNotFoundError creates a new Error with NotFound type for a missing account

func NewAdminPermissionError

func NewAdminPermissionError() error

NewAdminPermissionError creates a new Error with PermissionDenied type for actions requiring admin role.

func NewGetAccountError

func NewGetAccountError(err error) error

NewGetAccountError creates a new Error with Internal type for an issue getting account

func NewGetAccountFromStoreError

func NewGetAccountFromStoreError(err error) error

func NewGetUserFromStoreError

func NewGetUserFromStoreError() error

NewGetUserFromStoreError creates a new Error with Internal type for an issue getting user from store

func NewGroupNotFoundError

func NewGroupNotFoundError(groupID string) error

NewGroupNotFoundError creates a new Error with NotFound type for a missing group

func NewInvalidKeyIDError

func NewInvalidKeyIDError() error

NewInvalidKeyIDError creates a new Error with InvalidArgument type for an issue getting a setup key

func NewNameServerGroupNotFoundError

func NewNameServerGroupNotFoundError(nsGroupID string) error

NewNameServerGroupNotFoundError creates a new Error with NotFound type for a missing name server group

func NewNetworkNotFoundError

func NewNetworkNotFoundError(networkID string) error

NewNetworkNotFoundError creates a new Error with NotFound type for a missing network.

func NewNetworkResourceNotFoundError

func NewNetworkResourceNotFoundError(resourceID string) error

NewNetworkResourceNotFoundError creates a new Error with NotFound type for a missing network resource.

func NewNetworkRouterNotFoundError

func NewNetworkRouterNotFoundError(routerID string) error

NewNetworkRouterNotFoundError creates a new Error with NotFound type for a missing network router.

func NewPeerLoginExpiredError

func NewPeerLoginExpiredError() error

NewPeerLoginExpiredError creates a new Error with PermissionDenied type for an expired peer

func NewPeerNotFoundError

func NewPeerNotFoundError(peerKey string) error

NewPeerNotFoundError creates a new Error with NotFound type for a missing peer

func NewPeerNotRegisteredError

func NewPeerNotRegisteredError() error

NewPeerNotRegisteredError creates a new Error with NotFound type for a missing peer

func NewPermissionDeniedError

func NewPermissionDeniedError() error

NewPermissionDeniedError creates a new Error with PermissionDenied type for a permission denied error.

func NewPermissionValidationError

func NewPermissionValidationError(err error) error

func NewPolicyNotFoundError

func NewPolicyNotFoundError(policyID string) error

NewPolicyNotFoundError creates a new Error with NotFound type for a missing policy

func NewPostureChecksNotFoundError

func NewPostureChecksNotFoundError(postureChecksID string) error

NewPostureChecksNotFoundError creates a new Error with NotFound type for a missing posture checks

func NewResourceNotPartOfNetworkError

func NewResourceNotPartOfNetworkError(resourceID, networkID string) error

func NewRouterNotPartOfNetworkError

func NewRouterNotPartOfNetworkError(routerID, networkID string) error

func NewSetupKeyNotFoundError

func NewSetupKeyNotFoundError(setupKeyID string) error

NewSetupKeyNotFoundError creates a new Error with NotFound type for a missing setup key

func NewUserNotFoundError

func NewUserNotFoundError(userKey string) error

NewUserNotFoundError creates a new Error with NotFound type for a missing user

func NewUserNotPartOfAccountError

func NewUserNotPartOfAccountError() error

NewUserNotPartOfAccountError creates a new Error with PermissionDenied type for a user not being part of an account

Types

type Error

type Error struct {
	ErrorType Type
	Message   string
}

Error is an internal error

func FromError

func FromError(err error) (s *Error, ok bool)

FromError returns Error, true if the provided error is of type of Error. nil, false otherwise

func (*Error) Error

func (e *Error) Error() string

Error is an error string

func (*Error) Type

func (e *Error) Type() Type

Type returns the Type of the error

type Type

type Type int32

Type is a type of the Error

const (
	// UserAlreadyExists indicates that user already exists
	UserAlreadyExists Type = 1

	// PreconditionFailed indicates that some pre-condition for the operation hasn't been fulfilled
	PreconditionFailed Type = 2

	// PermissionDenied indicates that user has no permissions to view data
	PermissionDenied Type = 3

	// NotFound indicates that the object wasn't found in the system (or under a given Account)
	NotFound Type = 4

	// Internal indicates some generic internal error
	Internal Type = 5

	// InvalidArgument indicates some generic invalid argument error
	InvalidArgument Type = 6

	// AlreadyExists indicates a generic error when an object already exists in the system
	AlreadyExists Type = 7

	// Unauthorized indicates that user is not authorized
	Unauthorized Type = 8

	// BadRequest indicates that user is not authorized
	BadRequest Type = 9

	// Unauthenticated indicates that user is not authenticated due to absence of valid credentials
	Unauthenticated Type = 10
)