server

Documentation

Index

• func DecodeListFindingEventsRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)
• func EncodeListFindingEventsResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error
• func ListFindingEventsEventsPath() string
• func Mount(mux goahttp.Muxer, h *Server)
• func MountListFindingEventsHandler(mux goahttp.Muxer, h http.Handler)
• func NewListFindingEventsHandler(endpoint goa.Endpoint, mux goahttp.Muxer, ...) http.Handler
• func NewListFindingEventsPayload(minScore *int, maxScore *int, minDate *string, maxDate *string, page *int, ...) *events.ListFindingEventsPayload
• type ErrorNamer
• type EventResponse
• type EventResponseCollection
  • func NewEventResponseCollection(res eventsviews.EventCollectionView) EventResponseCollection
• type MountPoint
• type Server
  • func New(e *events.Endpoints, mux goahttp.Muxer, ...) *Server
  • func (s *Server) Service() string
  • func (s *Server) Use(m func(http.Handler) http.Handler)

Functions

func DecodeListFindingEventsRequest

func DecodeListFindingEventsRequest(mux goahttp.Muxer, decoder func(*http.Request) goahttp.Decoder) func(*http.Request) (interface{}, error)

DecodeListFindingEventsRequest returns a decoder for requests sent to the events List finding events endpoint.

func EncodeListFindingEventsResponse

func EncodeListFindingEventsResponse(encoder func(context.Context, http.ResponseWriter) goahttp.Encoder) func(context.Context, http.ResponseWriter, interface{}) error

EncodeListFindingEventsResponse returns an encoder for responses returned by the events List finding events endpoint.

func ListFindingEventsEventsPath

func ListFindingEventsEventsPath() string

ListFindingEventsEventsPath returns the URL path to the events service List finding events HTTP endpoint.

func Mount

func Mount(mux goahttp.Muxer, h *Server)

Mount configures the mux to serve the events endpoints.

func MountListFindingEventsHandler

func MountListFindingEventsHandler(mux goahttp.Muxer, h http.Handler)

MountListFindingEventsHandler configures the mux to serve the "events" service "List finding events" endpoint.

func NewListFindingEventsHandler

func NewListFindingEventsHandler(
	endpoint goa.Endpoint,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(err error) goahttp.Statuser,
) http.Handler

NewListFindingEventsHandler creates a HTTP handler which loads the HTTP request and calls the "events" service "List finding events" endpoint.

func NewListFindingEventsPayload

func NewListFindingEventsPayload(minScore *int, maxScore *int, minDate *string, maxDate *string, page *int, size *int) *events.ListFindingEventsPayload

NewListFindingEventsPayload builds a events service List finding events endpoint payload.

Types

type ErrorNamer

type ErrorNamer interface {
	ErrorName() string
}

ErrorNamer is an interface implemented by generated error structs that exposes the name of the error as defined in the design.

type EventResponse

type EventResponse struct {
	// Finding event ID
	ID *string `form:"id,omitempty" json:"id,omitempty" xml:"id,omitempty"`
	// Finding ID
	FindingID *string `form:"finding_id,omitempty" json:"finding_id,omitempty" xml:"finding_id,omitempty"`
	// Source ID
	SourceID *string `form:"source_id,omitempty" json:"source_id,omitempty" xml:"source_id,omitempty"`
	// Finding severity score
	Score *float32 `form:"score,omitempty" json:"score,omitempty" xml:"score,omitempty"`
	// Event time
	Time *string `form:"time,omitempty" json:"time,omitempty" xml:"time,omitempty"`
}

EventResponse is used to define fields on response body types.

type EventResponseCollection

type EventResponseCollection []*EventResponse

EventResponseCollection is the type of the "events" service "List finding events" endpoint HTTP response body.

func NewEventResponseCollection

func NewEventResponseCollection(res eventsviews.EventCollectionView) EventResponseCollection

NewEventResponseCollection builds the HTTP response body from the result of the "List finding events" endpoint of the "events" service.

type MountPoint

type MountPoint struct {
	// Method is the name of the service method served by the mounted HTTP handler.
	Method string
	// Verb is the HTTP method used to match requests to the mounted handler.
	Verb string
	// Pattern is the HTTP request path pattern used to match requests to the
	// mounted handler.
	Pattern string
}

MountPoint holds information about the mounted endpoints.

type Server

type Server struct {
	Mounts            []*MountPoint
	ListFindingEvents http.Handler
}

Server lists the events service endpoint HTTP handlers.

func New

func New(
	e *events.Endpoints,
	mux goahttp.Muxer,
	decoder func(*http.Request) goahttp.Decoder,
	encoder func(context.Context, http.ResponseWriter) goahttp.Encoder,
	errhandler func(context.Context, http.ResponseWriter, error),
	formatter func(err error) goahttp.Statuser,
) *Server

New instantiates HTTP handlers for all the events service endpoints using the provided encoder and decoder. The handlers are mounted on the given mux using the HTTP verb and path defined in the design. errhandler is called whenever a response fails to be encoded. formatter is used to format errors returned by the service methods prior to encoding. Both errhandler and formatter are optional and can be nil.

func (*Server) Service

func (s *Server) Service() string

Service returns the name of the service served.

func (*Server) Use

func (s *Server) Use(m func(http.Handler) http.Handler)

Use wraps the server handlers with the given middleware.