metering

type AggregationType string

type BaseConsumptionTags struct {
	Feature      string `json:"feature"`            //VolumeSets, Workloads, Ingress, SpiceDb, etc.
	Metric       string `json:"metric"`             //Required. CPU, Memory, Egress, StorageCapacity, etc.
	Org          string `json:"org"`                //Required. Everything lives in an org
	Gvc          string `json:"gvc,omitempty"`      //Optional. Not all resources are gvc-scoped
	Name         string `json:"name"`               //Required. All metered entities have a name.
	Location     string `json:"location,omitempty"` //Optional. It's possible that some objects will be global
	LocationType string `json:"locationType"`
}

type Bucket struct {
	Id               int64     `json:"id"`
	PartitionsEnding time.Time `json:"partitionsEnding" gorm:"type:timestamptz"`
	Created          time.Time `json:"created" gorm:"type:timestamptz;default:now()"`
	Orgs             []*Org    `json:"orgs,omitempty"`
}

type ChargeDetail struct {
	Charge           math.Float64 `json:"amount"`
	Units            math.Float64 `json:"units"`
	Rate             math.Float64 `json:"rate"`
	RatePlanItem     string       `json:"ratePlanItem"`
	ChargeableItemId string       `json:"chargeableItemId"`
	From             math.Float64 `json:"from"`
	To               math.Float64 `json:"to"`
}

type Charges struct {
	Charge   math.Float64   `json:"total"`
	Currency string         `json:"currency,omitempty"`
	RatePlan []string       `json:"ratePlans"`
	Details  []ChargeDetail `json:"details,omitempty" gorm:"type:jsonb"`
	// contains filtered or unexported fields
}

type Client interface {
	SetProfiling(enabled bool)
	QueryTagValues(token string, org string, query *TagValuesQueryRequest) (*TagValuesQueryResult, error)
	QueryByOrg(token string, org string, query *QueryRequest) (*QueryResult, error)
	Query(token string, query *QueryRequest) (*QueryResult, error)

	/*
	  DecomposeAndQueryByOrg and DecomposeAndQuery ensure that the given query is executed (at least) once for each
	  subSegment. If the subSegments are not aligned with query.TimeStep, the query will be decomposed into smaller
	  TimeSteps, given by decomposeInto.

	  Decomposition will fail if the query.TimeSegment is not aligned with the
	  smallest value in decomposeInto. e.g. if you give a query with a TimeSegment of
	  2023-01-01T00:01:01 - 2023-01-02T00:00:00, decomposition will fail because the start time is not aligned with the
	  smallest possible TimeStep (TimeStepHour)
	*/
	DecomposeAndQueryByOrg(token string, org string, query *QueryRequest, boundaryTimes []time.Time, decomposeInto []timeUtils.TimeStep) ([]*QueryResult, error)
	DecomposeAndQuery(token string, query *QueryRequest, boundaryTimes []time.Time, decomposeInto []timeUtils.TimeStep) ([]*QueryResult, error)
	GroupQueryResults(results []*QueryResult, aggregationPeriod timeUtils.TimeSegment, timeStep timeUtils.TimeStep, aggregateByTimeStep bool) (*QueryResult, error)

	AdminListCheckpoints(token string) (*checkpoints.ListCheckpointsResult, error)
	AdminResetCheckpoints(token string, request *checkpoints.ResetCheckpointsRequest) error
	AdminQueryCheckpoints(token string, request *checkpoints.QueryCheckpointsRequest) (*checkpoints.QueryCheckpointsResult, error)

	GetBucket(token string, request *GetBucketRequest) (*Bucket, error)
	ListBuckets(token string) ([]*Bucket, error)

	InjectConsumption(token string, org string, req *InjectConsumptionRequest) (*InjectConsumptionResponse, error)
}

type Consumption struct {
	*Charges        `gorm:"-"`
	ProjectedCharge math.Float64 `json:"projectedTotal,omitempty" gorm:"-"`
	Value           math.Float64 `json:"value"`
	ProjectedValue  math.Float64 `json:"projectedValue,omitempty" gorm:"-"`
	Job             string       `json:"job,omitempty"`
	Tags            any          `json:"tags" gorm:"type:jsonb"`
	// contains filtered or unexported fields
}

type ConsumptionGroup struct {
	Key          map[string]any `json:"key"`
	Consumptions []*Consumption `json:"consumptions"`
}

type ConsumptionPeriod struct {
	StartTime        time.Time           `json:"startTime"`
	EndTime          time.Time           `json:"endTime"`
	TotalSeconds     math.Float64        `json:"totalSeconds"`
	ElapsedSeconds   math.Float64        `json:"elapsedSeconds,omitempty"`
	ConsumptionCount int                 `json:"consumptionCount"`
	Groups           []*ConsumptionGroup `json:"groups"`
}

type ConsumptionQuery struct {
	FilterBy        map[string]string `json:"filterBy"`
	AggregateBy     []string          `json:"aggregateBy,omitempty"`
	ChargeableItems []string          `json:"chargeableItems,omitempty"`
	Jobs            []string          `json:"jobs,omitempty"`
}

type CopyOrgRequest struct {
	SourceBucket      int64     `json:"sourceBucket"`
	DestinationBucket int64     `json:"destinationBucket"`
	StartTime         time.Time `json:"startTime"`
	EndTime           time.Time `json:"endTime"`
}

type CustomIngressConsumptionTags struct {
	BaseConsumptionTags
	CustomIngress string `json:"customIngress"`
}

type GetBucketRequest struct {
	Id int64 `json:"id"`
}

type InjectConsumptionRequest struct {
	ChargeableItem string         `json:"chargeableItem"`
	Value          float64        `json:"value"`
	StartTime      time.Time      `json:"startTime"`
	Tags           map[string]any `json:"tags"`
}

type InjectConsumptionResponse struct {
	Success       bool    `json:"success"`
	Delta         float64 `json:"delta"`
	PreviousValue float64 `json:"previousValue"`
	NewValue      float64 `json:"newValue"`
}

type LoadBalancerConsumptionTags struct {
	CustomIngressConsumptionTags
	Workload         string `json:"workload,omitempty"`
	LoadBalancerKind string `json:"loadBalancerKind,omitempty"`
	LoadBalancerId   string `json:"loadBalancerId"`
}

type Mk8sClusterConsumptionTags struct {
	BaseConsumptionTags
	Mk8sCluster string `json:"mk8sCluster"`
}

type MoveOrgRequest struct {
	SourceBucket      int64     `json:"sourceBucket"`
	DestinationBucket int64     `json:"destinationBucket"`
	StartTime         time.Time `json:"startTime"`
	EndTime           time.Time `json:"endTime"`
}

type Org struct {
	Name     string    `json:"name" gorm:"primaryKey"`
	Created  time.Time `json:"created" gorm:"type:timestamptz;default:now()"`
	BucketId int64     `json:"bucketId"`
	Bucket   *Bucket   `json:"bucket,omitempty"`
}

type QueryRequest struct {
	StartTime           time.Time          `json:"startTime"`
	EndTime             time.Time          `json:"endTime"`
	TimeStep            timeUtils.TimeStep `json:"timeStep"`
	GroupBy             []string           `json:"groupBy,omitempty"`
	AggregateByTimeStep bool               `json:"aggregateByTimeStep"`

	ConsumptionQueries []*ConsumptionQuery `json:"consumptionQueries"`
}

type QueryResult struct {
	Periods          []*ConsumptionPeriod `json:"periods"`
	ConsumptionCount int                  `json:"consumptionCount"`
}

type QueryResultAggregator struct {
	TimeStep timeUtils.TimeStep
	timeUtils.TimeSegment
	AggregateByTimeStep bool
	// contains filtered or unexported fields
}

type ScrubOrgRequest struct {
	DestinationBucket int64     `json:"destinationBucket"`
	StartTime         time.Time `json:"startTime"`
	EndTime           time.Time `json:"endTime"`
}

type TagValuesQueryRequest struct {
	StartTime time.Time         `json:"startTime"`
	EndTime   time.Time         `json:"endTime"`
	Tag       string            `json:"tag"`
	FilterBy  map[string]string `json:"filterBy"`
}

type TagValuesQueryResult struct {
	*TagValuesQueryRequest
	TagValues []string `json:"tagValues"`
}

type VolumeSetConsumptionTags struct {
	WorkloadConsumptionTags
	VolumeIndex      int    `json:"volumeIndex"`
	VolumeSet        string `json:"volumeSet"`
	Driver           string `json:"driver"`
	PerformanceClass string `json:"performanceClass"`
}

type VolumeSetSnapshotConsumptionTags struct {
	VolumeSetConsumptionTags
	SnapshotName string `json:"snapshotName"`
	// The cloud provider's own id for the snapshot. omitempty keeps capacity-metered rows
	// byte-identical to what they were before cost metering existed, so row identity holds.
	SnapshotId string `json:"snapshotId,omitempty"`
}

type WorkloadConsumptionTags struct {
	BaseConsumptionTags
	Workload     string `json:"workload"`
	WorkloadType string `json:"workloadType"`
}