model

package

v1.1.1 Latest Latest Go to latest Published: Apr 2, 2024 License: MIT Imports: 1 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/adevinta/vulcan-reports-generator

Links

Open Source Insights

Documentation ¶

Constants ¶

View Source

const (
	// NotifFmtHTML indicates notification has HTML format.
	NotifFmtHTML = iota
	// NotifFmtText indicates notification has Text format.
	NotifFmtText

	// LiveReportType identifies the live report type.
	LiveReportType = "livereport"

	// StatusGenerating indicates that report is being generated.
	StatusGenerating = "GENERATING"
	// StatusFinished indicates that report has been generated.
	StatusFinished = "FINISHED"
	// StatusFailed indicates that report generation failed.
	StatusFailed = "FAILED"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type BaseReport ¶

type BaseReport struct {
	ID           string
	Notification Notification
	DeliveredTo  []string
	Status       string
	CreatedAt    time.Time
	UpdatedAt    time.Time
}

BaseReport represents the common fields for all types of reports.

type FileInfo ¶

type FileInfo struct {
	FilePath   string
	DestBucket string
	DestPath   string
}

FileInfo contains report file and its upload destination.

type LiveReport ¶

type LiveReport struct {
	BaseReport
	TeamID   string
	DateFrom string
	DateTo   string
}

LiveReport represents a report for vulcan team.

func (*LiveReport) GetCreatedAt ¶

func (r *LiveReport) GetCreatedAt() time.Time

func (*LiveReport) GetDateFrom ¶

func (r *LiveReport) GetDateFrom() string

func (*LiveReport) GetDateTo ¶

func (r *LiveReport) GetDateTo() string

func (*LiveReport) GetDeliveredTo ¶

func (r *LiveReport) GetDeliveredTo() []string

func (*LiveReport) GetID ¶

func (r *LiveReport) GetID() string

func (*LiveReport) GetNotification ¶

func (r *LiveReport) GetNotification() Notification

func (*LiveReport) GetStatus ¶

func (r *LiveReport) GetStatus() string

func (*LiveReport) GetTeamID ¶

func (r *LiveReport) GetTeamID() string

func (*LiveReport) GetUpdatedAt ¶

func (r *LiveReport) GetUpdatedAt() time.Time

type NotifFmt ¶

type NotifFmt uint8

NotifFmt represents the report notification format.

type Notification ¶

type Notification struct {
	Subject string
	Body    string
	Fmt     NotifFmt
}

Notification represents a report notification.

type Report ¶

type Report interface {
	GetID() string
	GetNotification() Notification
	GetDeliveredTo() []string
	GetStatus() string
	GetCreatedAt() time.Time
	GetUpdatedAt() time.Time
}

Report represents the interface which all report types must comply with.

type ReportType ¶

type ReportType string

ReportType specifies a report type.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL