mirror of
https://github.com/grafana/grafana.git
synced 2025-02-15 01:53:33 -06:00
9855e74b92
Chore: Refactor quota service (#57586) * Chore: refactore quota service * Apply suggestions from code review
31 lines
1.5 KiB
Go
31 lines
1.5 KiB
Go
package quota
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/grafana/grafana/pkg/models"
|
|
)
|
|
|
|
type Service interface {
|
|
// GetQuotasByScope returns the quota for the specific scope (global, organization, user)
|
|
// If the scope is organization, the ID is expected to be the organisation ID.
|
|
// If the scope is user, the id is expected to be the user ID.
|
|
GetQuotasByScope(ctx context.Context, scope Scope, ID int64) ([]QuotaDTO, error)
|
|
// Update overrides the quota for a specific scope (global, organization, user).
|
|
// If the cmd.OrgID is set, then the organization quota are updated.
|
|
// If the cmd.UseID is set, then the user quota are updated.
|
|
Update(ctx context.Context, cmd *UpdateQuotaCmd) error
|
|
// QuotaReached is called by the quota middleware for applying quota enforcement to API handlers
|
|
QuotaReached(c *models.ReqContext, targetSrv TargetSrv) (bool, error)
|
|
// CheckQuotaReached checks if the quota limitations have been reached for a specific service
|
|
CheckQuotaReached(ctx context.Context, targetSrv TargetSrv, scopeParams *ScopeParameters) (bool, error)
|
|
// DeleteQuotaForUser deletes custom quota limitations for the user
|
|
DeleteQuotaForUser(ctx context.Context, userID int64) error
|
|
// DeleteByOrg(ctx context.Context, orgID int64) error
|
|
|
|
// RegisterQuotaReporter registers a service UsageReporterFunc, targets and their default limits
|
|
RegisterQuotaReporter(e *NewUsageReporter) error
|
|
}
|
|
|
|
type UsageReporterFunc func(ctx context.Context, scopeParams *ScopeParameters) (*Map, error)
|