runs

type CorrectOptions struct {
	// PeriodFrom and PeriodTo are the half-open interval of the billing month,
	// as internal/engine/period derives it.
	PeriodFrom, PeriodTo time.Time
	// AttributingRelationTypes are the relation types attribution walks. An
	// empty list is attribution turned off.
	AttributingRelationTypes []string
	// AdjustmentRelationTypes are the relation types adjustment resolution
	// walks from a statement's project. An empty list is adjustments turned
	// off.
	AdjustmentRelationTypes []string
	// AdjustmentDepth bounds that walk: how many relation levels it follows
	// from the statement's project, at least 1. The configuration checks it,
	// and so does adjustments.New.
	AdjustmentDepth int
	// Counters is the counter sources file of the deployment, empty where it
	// measures no counter metric.
	Counters counters.Config
	// VM answers the metricsql counter sources. It is nil unless
	// Counters.HasMetricsQL() reports that any source needs it.
	VM counters.Querier
}

type CorrectionResult struct {
	// RunID is the correction run that was opened. It is the zero id when the
	// call was refused before any row was written.
	RunID uuid.UUID
	// CorrectsRunID is the finalized run the correction diffed against, which
	// its run row and every delta it wrote name.
	CorrectsRunID uuid.UUID
	// PricingVersion is the model version the period was rated with, which is
	// the one the corrected run recorded.
	PricingVersion string
	// Stats is what the correction counted, the same object it stored in
	// runs.stats.
	Stats CorrectionStats
	// Superseded are the completed correction runs of the period this one
	// replaced.
	Superseded []uuid.UUID
	// Reclaimed are the runs of the period that were still 'running' with no
	// process behind them and were failed before this run opened.
	Reclaimed []uuid.UUID
}

type CorrectionStats struct {
	Stats
	Deltas           int `json:"deltas"`
	AdjustmentDeltas int `json:"adjustment_deltas"`
}

type LateReport struct {
	// RunID is the latest finalized run of the period, the one a correction
	// would diff against.
	RunID uuid.UUID
	// Kind is that run's kind, KindRegular or KindCorrection: the regular run
	// that closed the month, or the last correction finalized over it.
	Kind string
	// SnapshotAt is the instant that run read the reporting database at, in
	// UTC. It is what the events listed here arrived after.
	SnapshotAt time.Time
	// Resources are the resources whose events arrived late, with how many did
	// and when the last of them did. It is empty when nothing arrived late, and
	// holds at most source.LateResourceLimit entries.
	Resources []source.LateResource
	// Truncated is how many further resources have late events beyond the ones
	// Resources names. It is zero where Resources names every one of them.
	Truncated int
}

type Options struct {
	// PeriodFrom and PeriodTo are the half-open interval of the billing month,
	// as internal/engine/period derives it.
	PeriodFrom, PeriodTo time.Time
	// Clouds are the clouds to meter. An empty list meters every cloud the
	// projection knows, which is the only meaning the engine can give it: it
	// keeps no cloud list of its own.
	Clouds []string
	// AttributingRelationTypes are the relation types attribution walks. An
	// empty list is attribution turned off.
	AttributingRelationTypes []string
	// AdjustmentRelationTypes are the relation types adjustment resolution
	// walks from a statement's project. An empty list is adjustments turned
	// off.
	AdjustmentRelationTypes []string
	// AdjustmentDepth bounds that walk: how many relation levels it follows
	// from the statement's project, at least 1. The configuration checks it,
	// and so does adjustments.New.
	AdjustmentDepth int
	// Counters is the counter sources file of the deployment, empty where it
	// measures no counter metric.
	Counters counters.Config
	// VM answers the metricsql counter sources. It is nil unless
	// Counters.HasMetricsQL() reports that any source needs it.
	VM counters.Querier
}

type Result struct {
	// RunID is the run that was opened. It is the zero id when the call was
	// refused before any row was written.
	RunID uuid.UUID
	// PricingVersion is the model version the period was rated with, which the
	// CLI prints beside the run.
	PricingVersion string
	// Stats is what the run counted, the same object it stored in runs.stats.
	Stats Stats
	// Superseded are the completed regular runs of the period this one replaced.
	Superseded []uuid.UUID
	// Reclaimed are the runs of the period that were still 'running' with no
	// process behind them and were failed before this run opened.
	Reclaimed []uuid.UUID
}

type Stats struct {
	SnapshotAt           *time.Time                       `json:"snapshot_at,omitempty"`
	Candidates           int                              `json:"candidates"`
	UsageRecords         int                              `json:"usage_records"`
	RatedRecords         int                              `json:"rated_records"`
	Statements           int                              `json:"statements"`
	AdjustmentRecords    int                              `json:"adjustment_records,omitempty"`
	Warnings             []Warning                        `json:"warnings,omitempty"`
	MeteringWarnings     []metering.Warning               `json:"metering_warnings,omitempty"`
	CounterWarnings      []counters.Warning               `json:"counter_warnings,omitempty"`
	AttributionWarnings  []attribution.Warning            `json:"attribution_warnings,omitempty"`
	AdjustmentWarnings   []adjustments.Warning            `json:"adjustment_warnings,omitempty"`
	Unpriced             []rating.UnpricedResourceType    `json:"unpriced,omitempty"`
	Unreadable           []rating.UnreadableQuantity      `json:"unreadable,omitempty"`
	UnregisteredProjects []statements.UnregisteredProject `json:"unregistered_projects,omitempty"`
	Violations           []metering.ResourceViolations    `json:"violations,omitempty"`
	Error                string                           `json:"error,omitempty"`
}

type Warning struct {
	Code   string `json:"code"`
	Detail string `json:"detail"`
}