types

Documentation

Overview

Package types contains declaration of data types used by other packages from RedHatInsights/insights-operator-utils

Index

• Variables
• func HandleServerError(writer http.ResponseWriter, err error)
• func Uint64ToUint32(v uint64) (uint32, error)
• type ErrorKey
• type ForbiddenError
  • func (e *ForbiddenError) Error() string
• type ItemNotFoundError
  • func (e *ItemNotFoundError) Error() string
• type MetricsConfiguration
• type NoBodyError
  • func (*NoBodyError) Error() string
• type NoContentError
  • func (e *NoContentError) Error() string
• type OutOfRangeError
  • func (e *OutOfRangeError) Error() string
• type RouterMissingParamError
  • func (e *RouterMissingParamError) Error() string
• type RouterParsingError
  • func (e *RouterParsingError) Error() string
• type RuleFQDN
• type UnauthorizedError
  • func (e *UnauthorizedError) Error() string
• type ValidationError
  • func (e *ValidationError) Error() string

Variables

var ErrOldReport = errors.New("More recent report already exists in storage")

ErrOldReport is an error returned if a more recent already exists on the storage while attempting to write a report for a cluster.

Functions

func HandleServerError

func HandleServerError(writer http.ResponseWriter, err error)

HandleServerError handles separate server errors and sends appropriate responses

func Uint64ToUint32

func Uint64ToUint32(v uint64) (uint32, error)

Uint64ToUint32 safely converts a uint64 into a uint32 without overflow

Types

type ErrorKey

type ErrorKey = types.ErrorKey

ErrorKey is a legacy type used for temporal compatibility

type ForbiddenError

type ForbiddenError struct {
	ErrString string
}

ForbiddenError means you don't have permission to do a particular action, for example your account belongs to a different organization

func (*ForbiddenError) Error

func (e *ForbiddenError) Error() string

type ItemNotFoundError

type ItemNotFoundError struct {
	ItemID interface{}
}

ItemNotFoundError shows that item with id ItemID wasn't found in the storage

func (*ItemNotFoundError) Error

func (e *ItemNotFoundError) Error() string

Error returns error string

type MetricsConfiguration

type MetricsConfiguration struct {
	Job              string `mapstructure:"job_name" toml:"job_name"`
	GatewayURL       string `mapstructure:"gateway_url" toml:"gateway_url"`
	GatewayAuthToken string `mapstructure:"gateway_auth_token" toml:"gateway_auth_token"`
	TimeBetweenPush  int    `mapstructure:"time_between_push" toml:"time_between_push"`
}

MetricsConfiguration holds metrics related configuration

type NoBodyError

type NoBodyError struct{}

NoBodyError error meaning that client didn't provide body when it's required

func (*NoBodyError) Error

func (*NoBodyError) Error() string

type NoContentError

type NoContentError struct {
	ErrString string
}

NoContentError means the client request is correct but the server doesn't have any data to return. For example, if a feature is disabled for a given cluster.

func (*NoContentError) Error

func (e *NoContentError) Error() string

type OutOfRangeError

type OutOfRangeError struct {
	Value uint64
	Type  string
}

OutOfRangeError indicates that a value is outside the expected range.

func (*OutOfRangeError) Error

func (e *OutOfRangeError) Error() string

Error returns a formatted error string for the OutOfRangeError.

type RouterMissingParamError

type RouterMissingParamError struct {
	ParamName string
}

RouterMissingParamError missing parameter in request

func (*RouterMissingParamError) Error

func (e *RouterMissingParamError) Error() string

type RouterParsingError

type RouterParsingError struct {
	ParamName  string
	ParamValue interface{}
	ErrString  string
}

RouterParsingError parsing error, for example string when we expected integer

func (*RouterParsingError) Error

func (e *RouterParsingError) Error() string

type RuleFQDN

type RuleFQDN = types.RuleFQDN

RuleFQDN is a legacy type used for temporal compatibility

type UnauthorizedError

type UnauthorizedError struct {
	ErrString string
}

UnauthorizedError means server can't authorize you, for example the token is missing or malformed

func (*UnauthorizedError) Error

func (e *UnauthorizedError) Error() string

type ValidationError

type ValidationError struct {
	ParamName  string
	ParamValue interface{}
	ErrString  string
}

ValidationError validation error, for example when string is longer then expected

func (*ValidationError) Error

func (e *ValidationError) Error() string