limes

type BurstingMultiplier float64

type ClusterAvailabilityZoneReport struct {
	Name        string `json:"name"`
	Capacity    uint64 `json:"capacity"`
	RawCapacity uint64 `json:"raw_capacity,omitempty"`
	Usage       uint64 `json:"usage,omitempty"`
}

type ClusterAvailabilityZoneReports map[string]*ClusterAvailabilityZoneReport

type ClusterRateLimitReport struct {
	RateInfo
	Limit  uint64 `json:"limit,omitempty"`
	Window Window `json:"window,omitempty"`
}

type ClusterRateLimitReports map[string]*ClusterRateLimitReport

type ClusterReport struct {
	ID           string                `json:"id"`
	Services     ClusterServiceReports `json:"services"`
	MaxScrapedAt *int64                `json:"max_scraped_at,omitempty"`
	MinScrapedAt *int64                `json:"min_scraped_at,omitempty"`
}

type ClusterResourceReport struct {
	//Several fields are pointers to values to enable precise control over which fields are rendered in output.
	ResourceInfo
	Capacity      *uint64                        `json:"capacity,omitempty"`
	RawCapacity   *uint64                        `json:"raw_capacity,omitempty"`
	CapacityPerAZ ClusterAvailabilityZoneReports `json:"per_availability_zone,omitempty"`
	DomainsQuota  *uint64                        `json:"domains_quota,omitempty"`
	Usage         uint64                         `json:"usage"`
	BurstUsage    uint64                         `json:"burst_usage,omitempty"`
	PhysicalUsage *uint64                        `json:"physical_usage,omitempty"`
	Subcapacities json.RawMessage                `json:"subcapacities,omitempty"`
}

type ClusterResourceReports map[string]*ClusterResourceReport

type ClusterServiceReport struct {
	ServiceInfo
	Resources         ClusterResourceReports  `json:"resources"`
	Rates             ClusterRateLimitReports `json:"rates,omitempty"`
	MaxScrapedAt      *int64                  `json:"max_scraped_at,omitempty"`
	MinScrapedAt      *int64                  `json:"min_scraped_at,omitempty"`
	MaxRatesScrapedAt *int64                  `json:"max_rates_scraped_at,omitempty"`
	MinRatesScrapedAt *int64                  `json:"min_rates_scraped_at,omitempty"`
}

type ClusterServiceReports map[string]*ClusterServiceReport

type DomainReport struct {
	UUID     string               `json:"id"`
	Name     string               `json:"name"`
	Services DomainServiceReports `json:"services"`
}

type DomainResourceReport struct {
	//Several fields are pointers to values to enable precise control over which fields are rendered in output.
	ResourceInfo
	DomainQuota          *uint64          `json:"quota,omitempty"`
	ProjectsQuota        *uint64          `json:"projects_quota,omitempty"`
	Usage                uint64           `json:"usage"`
	BurstUsage           uint64           `json:"burst_usage,omitempty"`
	PhysicalUsage        *uint64          `json:"physical_usage,omitempty"`
	BackendQuota         *uint64          `json:"backend_quota,omitempty"`
	InfiniteBackendQuota *bool            `json:"infinite_backend_quota,omitempty"`
	Scaling              *ScalingBehavior `json:"scales_with,omitempty"`
	//Annotations may contain arbitrary metadata that was configured for this
	//resource in this scope by Limes' operator.
	Annotations map[string]interface{} `json:"annotations,omitempty"`
}

type DomainResourceReports map[string]*DomainResourceReport

type DomainServiceReport struct {
	ServiceInfo
	Resources         DomainResourceReports `json:"resources"`
	MaxScrapedAt      *int64                `json:"max_scraped_at,omitempty"`
	MinScrapedAt      *int64                `json:"min_scraped_at,omitempty"`
	MaxRatesScrapedAt *int64                `json:"max_rates_scraped_at,omitempty"`
	MinRatesScrapedAt *int64                `json:"min_rates_scraped_at,omitempty"`
}

type DomainServiceReports map[string]*DomainServiceReport

type FractionalValueError struct {
	Source ValueWithUnit
	Target Unit
}

type IncompatibleUnitsError struct {
	Source Unit
	Target Unit
}

type ProjectBurstingInfo struct {
	Enabled    bool               `json:"enabled"`
	Multiplier BurstingMultiplier `json:"multiplier"`
}

type ProjectRateLimitReport struct {
	RateInfo
	//NOTE: Both Window fields must have pointer types because omitempty does not
	//work directly on json.Marshaler-implementing types.
	Limit         uint64  `json:"limit,omitempty"`
	Window        *Window `json:"window,omitempty"`
	DefaultLimit  uint64  `json:"default_limit,omitempty"`
	DefaultWindow *Window `json:"default_window,omitempty"`
	UsageAsBigint string  `json:"usage_as_bigint,omitempty"`
}

type ProjectRateLimitReports map[string]*ProjectRateLimitReport

type ProjectReport struct {
	UUID       string                `json:"id"`
	Name       string                `json:"name"`
	ParentUUID string                `json:"parent_id"`
	Bursting   *ProjectBurstingInfo  `json:"bursting,omitempty"`
	Services   ProjectServiceReports `json:"services"`
}

type ProjectResourceReport struct {
	//Several fields are pointers to values to enable precise control over which fields are rendered in output.
	ResourceInfo
	Quota         *uint64          `json:"quota,omitempty"`
	UsableQuota   *uint64          `json:"usable_quota,omitempty"`
	Usage         uint64           `json:"usage"`
	BurstUsage    uint64           `json:"burst_usage,omitempty"`
	PhysicalUsage *uint64          `json:"physical_usage,omitempty"`
	BackendQuota  *int64           `json:"backend_quota,omitempty"`
	Subresources  json.RawMessage  `json:"subresources,omitempty"`
	Scaling       *ScalingBehavior `json:"scales_with,omitempty"`
	//Annotations may contain arbitrary metadata that was configured for this
	//resource in this scope by Limes' operator.
	Annotations map[string]interface{} `json:"annotations,omitempty"`
}

type ProjectResourceReports map[string]*ProjectResourceReport

type ProjectServiceReport struct {
	ServiceInfo
	Resources      ProjectResourceReports  `json:"resources"`
	Rates          ProjectRateLimitReports `json:"rates,omitempty"`
	ScrapedAt      *int64                  `json:"scraped_at,omitempty"`
	RatesScrapedAt *int64                  `json:"rates_scraped_at,omitempty"`
}

type ProjectServiceReports map[string]*ProjectServiceReport

type QuotaRequest map[string]ServiceQuotaRequest

type RateInfo struct {
	Name string `json:"name"`
	Unit Unit   `json:"unit,omitempty"`
}

type RateLimitRequest struct {
	Limit  uint64
	Window Window
}

type ResourceInfo struct {
	Name string `json:"name"`
	Unit Unit   `json:"unit,omitempty"`
	//Category is an optional hint that UIs can use to group resources of one
	//service into subgroups. If it is used, it should be set on all
	//ResourceInfos reported by the same QuotaPlugin.
	Category string `json:"category,omitempty"`
	//If AutoApproveInitialQuota is non-zero, when a new project is scraped for
	//the first time, a backend quota equal to this value will be approved
	//automatically (i.e. Quota will be set equal to BackendQuota).
	AutoApproveInitialQuota uint64 `json:"-"`
	//If ExternallyManaged is true, quota cannot be set via the API. The quota
	//value reported by the QuotaPlugin is always authoritative.
	ExternallyManaged bool `json:"externally_managed,omitempty"`
	//If NoQuota is true, quota is not tracked at all for this resource. The
	//resource will only report usage. This field is not shown in API responses.
	//Check `res.Quota == nil` instead.
	NoQuota bool `json:"-"`
	//ContainedIn is an optional hint that UIs can use to group resources. If non-empty,
	//this resource is semantically contained within the resource with that name
	//in the same service.
	ContainedIn string `json:"contained_in,omitempty"`
}

type ResourceQuotaRequest map[string]ValueWithUnit

type ScalingBehavior struct {
	ScalesWithResourceName string  `json:"resource_name"`
	ScalesWithServiceType  string  `json:"service_type"`
	ScalingFactor          float64 `json:"factor"`
}

type ServiceInfo struct {
	//Type returns the service type that the backend service for this
	//plugin implements. This string must be identical to the type string from
	//the Keystone service catalog.
	Type string `json:"type"`
	//ProductName returns the name of the product that is the reference
	//implementation for this service. For example, ProductName = "nova" for
	//Type = "compute".
	ProductName string `json:"-"`
	//Area is a hint that UIs can use to group similar services.
	Area string `json:"area"`
}

type ServiceQuotaRequest struct {
	Resources ResourceQuotaRequest
	Rates     map[string]RateLimitRequest // key = rate name
}

type Unit string

type ValueWithUnit struct {
	Value uint64 `json:"value" yaml:"value"`
	Unit  Unit   `json:"unit"  yaml:"unit"`
}

type Window uint64