data

Documentation

Index

• Constants
• Variables
• func NewError(err any, errorTypes ...ErrorType) error
• func NewNotCachedError(item any) error
• func NewNotCachedRetryError(item any) error
• func NewNotFoundError(item any) error
• func NewUnknownError(item any) error
• type CacheCounters
• type Employee
  • func (e *Employee) MarshalBinary() ([]byte, error)
  • func (e *Employee) UnmarshalBinary(bytes []byte) error
• type EmployeePartial
  • func (e *EmployeePartial) MarshalBinary() ([]byte, error)
  • func (e *EmployeePartial) UnmarshalBinary(data []byte) error
• type EmployeeSearch
  • func (e *EmployeeSearch) FromParams(params url.Values)
  • func (e *EmployeeSearch) MarshalBinary() ([]byte, error)
  • func (e *EmployeeSearch) ToKey() (string, error)
  • func (e *EmployeeSearch) ToParams() url.Values
  • func (e *EmployeeSearch) UnmarshalBinary(data []byte) error
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Is(err error) bool
  • func (e *Error) MarshalBinary() ([]byte, error)
  • func (e *Error) Type() string
  • func (e *Error) UnmarshalBinary(bytes []byte) error
• type ErrorType
  • func (e ErrorType) StatusCode() int
• type Request
• type Response
• type Sleep
  • func (s *Sleep) MarshalBinary() ([]byte, error)
  • func (s *Sleep) UnmarshalBinary(bytes []byte) error
• type Timers

Constants

const (
	RouteEmployees       string = "/employees"
	RouteEmployeesSearch string = RouteEmployees + "/search"
	RouteEmployeesEmpNo  string = RouteEmployees + "/{" + PathEmpNo + "}"
	RouteEmployeesEmpNof string = RouteEmployees + "/%d"
	RouteCacheCounters   string = "/cachecounters"
	RouteCache           string = "/cache"
	RouteTimers          string = "/timers"
	RouteSleep           string = "/sleep"
)

const ParameterEmpNos string = "emp_nos"

const PathEmpNo string = "EmpNo"

Variables

var (
	ErrUnknown        error = &Error{ErrorType: ErrorTypeUnknown}
	ErrNotFound       error = &Error{ErrorType: ErrorTypeNotFound}
	ErrNotCached      error = &Error{ErrorType: ErrorTypeNotCached}
	ErrNotCachedRetry error = &Error{ErrorType: ErrorTypeNotCachedRetry}
)

var (
	Version   string
	GitCommit string
	GitBranch string
)

These variables are populated at build time REFERENCE: https://www.digitalocean.com/community/tutorials/using-ldflags-to-set-version-information-for-go-applications to find where the variables are...

go tool nm ./app | grep app

Functions

func NewError

func NewError(err any, errorTypes ...ErrorType) error

func NewNotCachedError

func NewNotCachedError(item any) error

func NewNotCachedRetryError

func NewNotCachedRetryError(item any) error

func NewNotFoundError

func NewNotFoundError(item any) error

func NewUnknownError

func NewUnknownError(item any) error

Types

type CacheCounters

type CacheCounters struct {
	CounterHits   map[string]int `json:"counter_hits,omitempty"`
	CounterMisses map[string]int `json:"counter_misses,omitempty"`
}

type Employee

type Employee struct {
	EmpNo     int64  `json:"emp_no"`
	BirthDate int64  `json:"birth_date"`
	FirstName string `json:"first_name"`
	LastName  string `json:"last_name"`
	Gender    string `json:"gender"`
	HireDate  int64  `json:"hire_date"`
}

func (*Employee) MarshalBinary

func (e *Employee) MarshalBinary() ([]byte, error)

func (*Employee) UnmarshalBinary

func (e *Employee) UnmarshalBinary(bytes []byte) error

type EmployeePartial

type EmployeePartial struct {
	BirthDate *int64  `json:"birth_date,omitempty,string"`
	FirstName *string `json:"first_name,omitempty"`
	LastName  *string `json:"last_name,omitempty"`
	Gender    *string `json:"gender,omitempty"`
	HireDate  *int64  `json:"hire_date,omitempty,string"`
}

func (*EmployeePartial) MarshalBinary

func (e *EmployeePartial) MarshalBinary() ([]byte, error)

func (*EmployeePartial) UnmarshalBinary

func (e *EmployeePartial) UnmarshalBinary(data []byte) error

type EmployeeSearch

type EmployeeSearch struct {
	EmpNos     []int64  `json:"emp_nos"`
	FirstNames []string `json:"first_names"`
	LastNames  []string `json:"last_names"`
	Gender     string   `json:"gender"`
}

func (*EmployeeSearch) FromParams

func (e *EmployeeSearch) FromParams(params url.Values)

func (*EmployeeSearch) MarshalBinary

func (e *EmployeeSearch) MarshalBinary() ([]byte, error)

func (*EmployeeSearch) ToKey

func (e *EmployeeSearch) ToKey() (string, error)

func (*EmployeeSearch) ToParams

func (e *EmployeeSearch) ToParams() url.Values

func (*EmployeeSearch) UnmarshalBinary

func (e *EmployeeSearch) UnmarshalBinary(data []byte) error

type Error

type Error struct {

	// Type contains the text of the type of error
	// example: not found
	ErrorType `json:"error_type"`

	// Error contains the text of any failed operation
	// example: employee not found
	ErrorMessage string `json:"error_message"`
	// contains filtered or unexported fields
}

Error represents any error that can be generated by bludgeon swagger:model Error

func (*Error) Error

func (e *Error) Error() string

func (*Error) Is

func (e *Error) Is(err error) bool

func (*Error) MarshalBinary

func (e *Error) MarshalBinary() ([]byte, error)

func (*Error) Type

func (e *Error) Type() string

func (*Error) UnmarshalBinary

func (e *Error) UnmarshalBinary(bytes []byte) error

type ErrorType

type ErrorType string

const (
	ErrorTypeUnknown        ErrorType = "ERR_UNKNOWN"
	ErrorTypeNotFound       ErrorType = "ERR_NOT_FOUND"
	ErrorTypeNotCached      ErrorType = "ERR_NOT_CACHED"
	ErrorTypeNotCachedRetry ErrorType = "ERR_NOT_CACHED_RETRY"
)

func (ErrorType) StatusCode

func (e ErrorType) StatusCode() int

type Request

type Request struct {
	EmployeePartial EmployeePartial `json:"employee_partial"`
}

type Response

type Response struct {
	Employee  *Employee   `json:"employee,omitempty"`
	Employees []*Employee `json:"employees,omitempty"`
}

type Sleep

type Sleep struct {
	Id       string `json:"sleep_id"`
	Duration int64  `json:"sleep_duration,string"`
}

func (*Sleep) MarshalBinary

func (s *Sleep) MarshalBinary() ([]byte, error)

func (*Sleep) UnmarshalBinary

func (s *Sleep) UnmarshalBinary(bytes []byte) error

type Timers

type Timers struct {
	Totals   map[string]int64 `json:"totals,omitempty"`
	Averages map[string]int64 `json:"averages,omitempty"`
}