core

Documentation

Index

• Variables
• type CSVRecordFormat
• type CSVRecords
  • func RenderReports(opts *OutputOpts, rL ...LimesReportRenderer) CSVRecords
  • func (d CSVRecords) Write(w io.Writer) error
  • func (d CSVRecords) WriteAsTable()
• type ClusterReport
• type DomainReport
• type LimesReportRenderer
  • func LimesDomainsToReportRenderer(in []limes.DomainReport) []LimesReportRenderer
  • func LimesProjectsToReportRenderer(in []limes.ProjectReport, domainID, domainName string, hasRatesOnly bool) []LimesReportRenderer
• type OutputFormat
• type OutputOpts
• type ProjectReport

Variables

var LimesUnits = []limes.Unit{
	limes.UnitBytes,
	limes.UnitKibibytes,
	limes.UnitMebibytes,
	limes.UnitGibibytes,
	limes.UnitTebibytes,
	limes.UnitPebibytes,
	limes.UnitExbibytes,
}

LimesUnits is a slice of units that Limes understands. Note: the units in this slice **must** be in ascending order.

Types

type CSVRecordFormat

type CSVRecordFormat int

CSVRecordFormat type defines the style of CSV records.

const (
	CSVRecordFormatDefault CSVRecordFormat = iota
	CSVRecordFormatLong
	CSVRecordFormatNames
)

Different types of CSVRecordFormat.

type CSVRecords

type CSVRecords [][]string

CSVRecords is exactly that.

func RenderReports

func RenderReports(opts *OutputOpts, rL ...LimesReportRenderer) CSVRecords

RenderReports renders multiple reports and returns the aggregate CSVRecords.

Note: if multiple LimesReportRenderer are given then they must have the same underlying type.

func (CSVRecords) Write

func (d CSVRecords) Write(w io.Writer) error

Write writes CSVRecords to w.

Note: the method takes an io.Writer because it is used in unit tests.

func (CSVRecords) WriteAsTable

func (d CSVRecords) WriteAsTable()

WriteAsTable writes CSVRecords to os.Stdout in table format.

type ClusterReport

type ClusterReport struct {
	*limes.ClusterReport
}

ClusterReport is a wrapper for limes.ClusterReport.

type DomainReport

type DomainReport struct {
	*limes.DomainReport
}

DomainReport is a wrapper for limes.DomainReport.

type LimesReportRenderer

type LimesReportRenderer interface {
	// contains filtered or unexported methods
}

LimesReportRenderer is implemented by data types that can render a Limes API report into CSVRecords.

func LimesDomainsToReportRenderer

func LimesDomainsToReportRenderer(in []limes.DomainReport) []LimesReportRenderer

LimesDomainsToReportRenderer wraps the given limes.DomainReport in a DomainReport and returns a []LimesReportRenderer.

func LimesProjectsToReportRenderer

func LimesProjectsToReportRenderer(
	in []limes.ProjectReport,
	domainID, domainName string,
	hasRatesOnly bool,
) []LimesReportRenderer

LimesProjectsToReportRenderer wraps the given limes.ProjectReport in a ProjectReport and returns a []LimesReportRenderer.

type OutputFormat

type OutputFormat string

OutputFormat that the app can print data in.

const (
	OutputFormatTable OutputFormat = "table"
	OutputFormatCSV   OutputFormat = "csv"
	OutputFormatJSON  OutputFormat = "json"
)

Different types of OutputFormat.

type OutputOpts

type OutputOpts struct {
	Fmt       OutputFormat
	CSVRecFmt CSVRecordFormat
	Humanize  bool
}

type ProjectReport

type ProjectReport struct {
	*limes.ProjectReport

	HasRatesOnly bool

	DomainID   string
	DomainName string
}

ProjectReport is a wrapper for limes.ProjectReport.