engine

type AttributeMatch struct {
	Key        string  `json:"key"`
	Value      *string `json:"value,omitempty"`
	ValueRegex *string `json:"value_regex,omitempty"`
}

type AttributeWithUnknownKeys struct {
	Attribute        string   `json:"attribute"`
	MissingVariables []string `json:"missingVariables"`
}

type BlankCoreResource struct {
	Name string
	Type string
}

type CatalogBuilder func(*ResourceSpec) CatalogItem

type CatalogEntry struct {
	Name                string
	Notes               []string
	RFunc               LegacyBuilder
	CoreRFunc           CatalogBuilder
	ReferenceAttributes []string
	CustomRefIDFunc     ReferenceIDFunc
	DefaultRefIDFunc    ReferenceIDFunc
	CloudResourceIDFunc CloudResourceIDFunc
	NoPrice             bool
	// GetRegion is used to look up the region of a resource if it has a region that
	// cannot be calculated from the default resource/provider data. If the GetRegion
	// is nil or the return result is empty the region will be calculated from the
	// default resource/provider data.
	GetRegion RegionLookupFunc
}

type CatalogItem interface {
	CoreType() string
	UsageSchema() []*ConsumptionField
	PopulateUsage(u *ConsumptionProfile)
	BuildResource() *Estimate
}

type CatalogItemWithConsumptionParams interface {
	CatalogItem
	UsageEstimationParams() []ConsumptionParam
}

type CloudResourceIDFunc func(d *ResourceSpec) []string

type ConsumptionField struct {
	Key          string
	DefaultValue interface{}
	Value        interface{}
	ValueType    UsageVariableType
	Description  string
}

type ConsumptionMap struct {
	// contains filtered or unexported fields
}

type ConsumptionParam struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type ConsumptionProfile struct {
	Address    string
	Attributes map[string]gjson.Result
}

type Diagnostic struct {
	Code    int         `json:"code"`
	Message string      `json:"message"`
	Data    interface{} `json:"data"`
	IsError bool        `json:"isError"`

	// FriendlyMessage should be used to display a readable message to the CLI user.
	FriendlyMessage string `json:"-"`
}

type Estimate struct {
	Name                                    string
	CostComponents                          []*LineItem
	ActualCosts                             []*ObservedCost
	SubResources                            []*Estimate
	HourlyCost                              *decimal.Decimal
	MonthlyCost                             *decimal.Decimal
	MonthlyUsageCost                        *decimal.Decimal
	IsSkipped                               bool
	NoPrice                                 bool
	SkipMessage                             string
	ResourceType                            string
	Tags                                    *map[string]string
	DefaultTags                             *map[string]string
	TagPropagation                          *TagPropagation
	ProviderSupportsDefaultTags             bool
	ProviderLink                            string
	UsageSchema                             []*ConsumptionField
	EstimateUsage                           UsageEstimator
	EstimationSummary                       map[string]bool
	Metadata                                map[string]gjson.Result
	MissingVarsCausingUnknownTagKeys        []string
	MissingVarsCausingUnknownDefaultTagKeys []string
	// contains filtered or unexported fields
}

type LegacyBuilder func(*ResourceSpec, *ConsumptionProfile) *Estimate

type LineItem struct {
	Name           string
	Unit           string
	UnitMultiplier decimal.Decimal
	// UnitRounding specifies the number of decimal places that the output unit should be rounded to.
	// This should be set to 0 if using MonthToHourUnitMultiplier otherwise the unit will show with
	// redundant .000 decimal places.
	UnitRounding         *int32
	IgnoreIfMissingPrice bool
	ProductFilter        *ProductSelector
	PriceFilter          *RateSelector
	HourlyQuantity       *decimal.Decimal
	MonthlyQuantity      *decimal.Decimal
	MonthlyDiscountPerc  float64

	HourlyCost    *decimal.Decimal
	MonthlyCost   *decimal.Decimal
	UsageBased    bool
	PriceNotFound bool
	// contains filtered or unexported fields
}

type ObservedCost struct {
	ResourceID     string
	StartTimestamp time.Time
	EndTimestamp   time.Time
	CostComponents []*LineItem
}

type Policies []Policy

type Policy struct {
	ID                 string           `json:"id"`
	Title              string           `json:"title"`
	Description        string           `json:"description"`
	ResourceType       string           `json:"resource_type"`
	ResourceAttributes json.RawMessage  `json:"resource_attributes"`
	Address            string           `json:"address"`
	Suggested          string           `json:"suggested"`
	NoCost             bool             `json:"no_cost"`
	Cost               *decimal.Decimal `json:"cost"`
}

type ProductSelector struct {
	VendorName       *string           `json:"vendorName,omitempty"`
	Service          *string           `json:"service,omitempty"`
	ProductFamily    *string           `json:"productFamily,omitempty"`
	Region           *string           `json:"region,omitempty"`
	Sku              *string           `json:"sku,omitempty"`
	AttributeFilters []*AttributeMatch `json:"attributeFilters,omitempty"`
}

type Projects []*Workspace

type RateSelector struct {
	PurchaseOption     *string `json:"purchaseOption,omitempty"`
	Unit               *string `json:"unit,omitempty"`
	Description        *string `json:"description,omitempty"`
	DescriptionRegex   *string `json:"description_regex,omitempty"`
	StartUsageAmount   *string `json:"startUsageAmount,omitempty"`
	EndUsageAmount     *string `json:"endUsageAmount,omitempty"`
	TermLength         *string `json:"termLength,omitempty"`
	TermPurchaseOption *string `json:"termPurchaseOption,omitempty"`
	TermOfferingClass  *string `json:"termOfferingClass,omitempty"`
}

type ReferenceIDFunc func(d *ResourceSpec) []string

type RegionLookupFunc func(defaultRegion string, d *ResourceSpec) string

type Remediater interface {
	// Describe provides an English description of the remediation action X that
	// would fit into a sentence "May we X?" (e.g. "enable bucket metrics").
	// The description can be used to prompt the user before taking action.
	Describe() string

	// Remediate attempts to fix a problem in the cloud that prevents estimation,
	// e.g. by enabling metrics collection on certain resources.
	Remediate() error
}

type ResourceSpec struct {
	Type                                    string
	ProviderName                            string
	Address                                 string
	Tags                                    *map[string]string
	DefaultTags                             *map[string]string
	ProviderSupportsDefaultTags             bool
	ProviderLink                            string
	TagPropagation                          *TagPropagation
	RawValues                               gjson.Result
	ReferencesMap                           map[string][]*ResourceSpec
	CFResource                              cloudformation.Resource
	UsageData                               *ConsumptionProfile
	Metadata                                map[string]gjson.Result
	ProjectMetadata                         map[string]string
	MissingVarsCausingUnknownTagKeys        []string
	MissingVarsCausingUnknownDefaultTagKeys []string
	// Region is the region of the resource. When building a resource callers should
	// use this value instead of the deprecated d.Get("region").String() or
	// lookupRegion method.
	Region string
}

type TagPropagation struct {
	To                    string             // a human-readable name of the type being propagated to - will not always have a tf type
	From                  *string            // e.g. SERVICE, TASK_DEFINITION
	Tags                  *map[string]string // tags that were propagated from the above resource, if any
	Attribute             string             // the attribute that can be used to configured propagation, e.g. propagate_tags
	HasRequiredAttributes bool               // whether the resource has the required attributes to warrant propagating tags
}

type UnpricedEntry struct {
	Type                                    string
	Address                                 string
	Tags                                    *map[string]string
	DefaultTags                             *map[string]string
	ProviderSupportsDefaultTags             bool
	ProviderLink                            string
	TagPropagation                          *TagPropagation
	UsageData                               *ConsumptionProfile
	Metadata                                map[string]gjson.Result
	MissingVarsCausingUnknownTagKeys        []string
	MissingVarsCausingUnknownDefaultTagKeys []string

	// CoreResource is the new/preferred struct for providing an intermediate-object
	// that contains all provider-derived information, but has not yet been built into
	// a Resource.
	CoreResource CatalogItem

	// Resource field is provided for backward compatibility with provider resource builders
	// that have not yet been converted to build CoreResource's
	Resource *Estimate

	// CloudResourceIDs are collected during parsing in case they need to be uploaded to the
	// Cloud Usage API to be used in the usage estimate calculations.
	CloudResourceIDs []string
}

type UsageEstimator func(context.Context, map[string]interface{}) error

type UsageVariableType int

type Vendor interface {
	Type() string
	DisplayType() string
	ProjectName() string
	RelativePath() string
	VarFiles() []string
	AddMetadata(*WorkspaceMeta)
	LoadResources(ConsumptionMap) ([]*Workspace, error)
	Context() *settings.ProjectSession
}

type VendorMeta struct {
	Name                      string                     `json:"name,omitempty"`
	DefaultTags               map[string]string          `json:"defaultTags,omitempty"`
	Filename                  string                     `json:"filename,omitempty"`
	StartLine                 int64                      `json:"startLine,omitempty"`
	EndLine                   int64                      `json:"endLine,omitempty"`
	AttributesWithUnknownKeys []AttributeWithUnknownKeys `json:"attributesWithUnknownKeys,omitempty"`
}

type Workspace struct {
	Name                 string
	Metadata             *WorkspaceMeta
	PartialPastResources []*UnpricedEntry
	PartialResources     []*UnpricedEntry
	PastResources        []*Estimate
	Resources            []*Estimate
	Diff                 []*Estimate
	HasDiff              bool
	DisplayName          string
}

type WorkspaceMeta struct {
	Path                string        `json:"path"`
	Type                string        `json:"type"`
	ConfigSha           string        `json:"configSha,omitempty"`
	PolicySha           string        `json:"policySha,omitempty"`
	PastPolicySha       string        `json:"pastPolicySha,omitempty"`
	TerraformModulePath string        `json:"terraformModulePath,omitempty"`
	TerraformWorkspace  string        `json:"terraformWorkspace,omitempty"`
	VCSSubPath          string        `json:"vcsSubPath,omitempty"`
	VCSCodeChanged      *bool         `json:"vcsCodeChanged,omitempty"`
	Errors              []*Diagnostic `json:"errors,omitempty"` // contains merged current and past errors
	CurrentErrors       []*Diagnostic `json:"currentErrors,omitempty"`
	PastErrors          []*Diagnostic `json:"pastErrors,omitempty"`
	Warnings            []*Diagnostic `json:"warnings,omitempty"`
	Policies            Policies      `json:"policies,omitempty"`
	Providers           []VendorMeta  `json:"providers,omitempty"`
	RemoteModuleCalls   []string      `json:"remoteModuleCalls,omitempty"`
}