usageManager

Documentation

Index

• type UsageManager
  • func New(db *dbManager.DbParameter, monit *statusManager.StatusManager) *UsageManager
  • func (m *UsageManager) GetSystemUsage(ctx context.Context, params usage_management.GetSystemUsageParams) middleware.Responder
  • func (m *UsageManager) GetUsage(ctx context.Context, params usage_management.GetUsageParams) middleware.Responder
  • func (m *UsageManager) GetUsageSummary(ctx context.Context, params usage_management.GetUsageSummaryParams) middleware.Responder

Types

type UsageManager

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

UsageManager is the struct defined to group and contain all the methods that interact with the usage endpoint. Parameters: - db: a DbParameter reference to be able to use the DBManager methods. - monit: a StatusManager reference to be able to use the status subsystem methods.

func New

func New(db *dbManager.DbParameter, monit *statusManager.StatusManager) *UsageManager

New is the function to create the struct UsageManager that grant access to the methods to interact with the usage endpoint. Parameters: - db: a reference to the DbParameter to be able to interact with the db methods. - monit: a reference to the StatusManager to be able to interact with the status subsystem. Returns: - UsageManager: struct to interact with the usage endpoint functionalities.

func (*UsageManager) GetSystemUsage

func (m *UsageManager) GetSystemUsage(ctx context.Context, params usage_management.GetSystemUsageParams) middleware.Responder

GetSystemUsage (Swagger func) is the function behind the (GET) endpoint /usage Its job is to retrieve the usage report given a certain time-window and with the posibility of filtering by metric.

func (*UsageManager) GetUsage

func (m *UsageManager) GetUsage(ctx context.Context, params usage_management.GetUsageParams) middleware.Responder

GetUsage (Swagger func) is the function behind the (GET) endpoint /usage/{id} Its job is to retrieve the usage report of the given account during the defined time-window, with the posibility of filtering by metric.

func (*UsageManager) GetUsageSummary

func (m *UsageManager) GetUsageSummary(ctx context.Context, params usage_management.GetUsageSummaryParams) middleware.Responder

GetUsageSummary (Swagger func) is the function behind the (GET) endpoint /usage/summary/{id} Its job is to retrieve easy to use for the UI usage report of all the products linked to the reseller account provided during the defined time-window.