quota

Documentation

Index

• Variables
• type QuotaService
  • func ProvideService(cfg *setting.Cfg, tokenService models.UserTokenService, ...) *QuotaService
  • func (qs *QuotaService) CheckQuotaReached(ctx context.Context, target string, scopeParams *ScopeParameters) (bool, error)
  • func (qs *QuotaService) QuotaReached(c *models.ReqContext, target string) (bool, error)
• type ScopeParameters
• type Service

Variables

var ErrInvalidQuotaTarget = errors.New("invalid quota target")

Types

type QuotaService

type QuotaService struct {
	AuthTokenService models.UserTokenService
	Cfg              *setting.Cfg
	SQLStore         sqlstore.Store
	Logger           log.Logger
}

func ProvideService

func ProvideService(cfg *setting.Cfg, tokenService models.UserTokenService, sqlStore *sqlstore.SQLStore) *QuotaService

func (*QuotaService) CheckQuotaReached

func (qs *QuotaService) CheckQuotaReached(ctx context.Context, target string, scopeParams *ScopeParameters) (bool, error)

CheckQuotaReached check that quota is reached for a target. If ScopeParameters are not defined, only global scope is checked

func (*QuotaService) QuotaReached

func (qs *QuotaService) QuotaReached(c *models.ReqContext, target string) (bool, error)

QuotaReached checks that quota is reached for a target. Runs CheckQuotaReached and take context and scope parameters from the request context

type ScopeParameters

type ScopeParameters struct {
	OrgId  int64
	UserId int64
}

type Service

type Service interface {
	QuotaReached(c *models.ReqContext, target string) (bool, error)
	CheckQuotaReached(ctx context.Context, target string, scopeParams *ScopeParameters) (bool, error)
}