api

Documentation

Index

• Variables
• func SetupRoute(r *gin.RouterGroup, handler Handler)
• type Error
• type ExecSearchRequest
• type ExecSearchResponse
• type GetSearchLogMetaData
• type GetSearchLogsResponse
• type GetSearchResponse
• type Handler
• type MinervaHandler
  • func (x *MinervaHandler) ExecSearch(c *gin.Context) (*Response, Error)
  • func (x *MinervaHandler) GetSearch(c *gin.Context) (*Response, Error)
  • func (x MinervaHandler) GetSearchLogs(c *gin.Context) (*Response, Error)
  • func (x *MinervaHandler) GetSearchTimeSeries(c *gin.Context) (*Response, Error)
• type MockHandler
  • func NewMockHandler() *MockHandler
  • func (x *MockHandler) ExecSearch(c *gin.Context) (*Response, Error)
  • func (x *MockHandler) GetSearch(c *gin.Context) (*Response, Error)
  • func (x *MockHandler) GetSearchLogs(c *gin.Context) (*Response, Error)
  • func (x *MockHandler) GetSearchTimeSeries(c *gin.Context) (*Response, Error)
• type Query
• type Response

Variables

var Logger = logrus.New()

Logger is exported to be used in external package.

Functions

func SetupRoute

func SetupRoute(r *gin.RouterGroup, handler Handler)

SetupRoute binds route of gin and API

Types

type Error

type Error interface {
	Error() string
	Code() int
	Message() string
	Cause() error
}

type ExecSearchRequest

type ExecSearchRequest struct {
	Query         []Query `json:"query"`
	StartDateTime string  `json:"start_dt"`
	EndDateTime   string  `json:"end_dt"`
}

type ExecSearchResponse

type ExecSearchResponse struct {
	SearchID searchID `json:"search_id"`
}

type GetSearchLogMetaData

type GetSearchLogMetaData struct {
	Total    int64    `json:"total"`
	SubTotal int64    `json:"sub_total"`
	Offset   int64    `json:"offset"`
	Limit    int64    `json:"limit"`
	Tags     []string `json:"tags"`
	// contains filtered or unexported fields
}

type GetSearchLogsResponse

type GetSearchLogsResponse struct {
	ID       searchID             `json:"search_id"`
	Logs     []*logData           `json:"logs"`
	MetaData GetSearchLogMetaData `json:"metadata"`
}

type GetSearchResponse

type GetSearchResponse struct {
	ID       searchID        `json:"search_id"`
	MetaData *searchMetaData `json:"metadata"`
}

type Handler

type Handler interface {
	ExecSearch(c *gin.Context) (*Response, Error)
	GetSearch(c *gin.Context) (*Response, Error)
	GetSearchLogs(c *gin.Context) (*Response, Error)
	GetSearchTimeSeries(c *gin.Context) (*Response, Error)
}

type MinervaHandler

type MinervaHandler struct {
	DatabaseName     string
	IndexTableName   string
	MessageTableName string
	OutputPath       string
	MetaTableName    string
	Region           string
}

func (*MinervaHandler) ExecSearch

func (x *MinervaHandler) ExecSearch(c *gin.Context) (*Response, Error)

func (*MinervaHandler) GetSearch

func (x *MinervaHandler) GetSearch(c *gin.Context) (*Response, Error)

func (MinervaHandler) GetSearchLogs

func (x MinervaHandler) GetSearchLogs(c *gin.Context) (*Response, Error)

func (*MinervaHandler) GetSearchTimeSeries

func (x *MinervaHandler) GetSearchTimeSeries(c *gin.Context) (*Response, Error)

type MockHandler

type MockHandler struct {
	LogTotal int
	LogLimit int
	// contains filtered or unexported fields
}

func NewMockHandler

func NewMockHandler() *MockHandler

func (*MockHandler) ExecSearch

func (x *MockHandler) ExecSearch(c *gin.Context) (*Response, Error)

func (*MockHandler) GetSearch

func (x *MockHandler) GetSearch(c *gin.Context) (*Response, Error)

func (*MockHandler) GetSearchLogs

func (x *MockHandler) GetSearchLogs(c *gin.Context) (*Response, Error)

func (*MockHandler) GetSearchTimeSeries

func (x *MockHandler) GetSearchTimeSeries(c *gin.Context) (*Response, Error)

type Query

type Query struct {
	Term string `json:"term" dynamo:"term"`
}

type Response

type Response struct {
	Code    int
	Message interface{}
}

Response is