plan

Documentation

Index

• type PlanRequest
• type PlanVariableRequest
• type Service
  • func New(db *gorm.DB) Service
  • func (s *Service) Add(ctx *gin.Context, req PlanRequest) (plan.Plan, error)
  • func (s *Service) AddValidation(req PlanRequest) error
  • func (s *Service) Cancel(ctx *gin.Context, id int) error
  • func (s *Service) PaginateList(ctx *gin.Context) ([]plan.Plan, error)
  • func (s *Service) Read(id int) (plan.Plan, error)
  • func (s *Service) Retry(ctx *gin.Context, id int) error

Types

type PlanRequest

type PlanRequest struct {
	Name      string                `json:"name" validate:"required"`
	Type      plan.Type             `json:"type" validate:"required"`
	Schedule  string                `json:"schedule"`
	ModuleID  int                   `json:"module_id" validate:"required"`
	Variables []PlanVariableRequest `json:"variables"`
}

type PlanVariableRequest

type PlanVariableRequest struct {
	Key       string                `json:"key" validate:"required"`
	Value     string                `json:"value" validate:"required"`
	Category  planVariable.Category `json:"category" validate:"required"`
	Sensitive bool                  `json:"sensitive"`
}

type Service

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

Service struct manages interactions with activities store

func New

func New(db *gorm.DB) Service

New creates a new Service struct

func (*Service) Add

func (s *Service) Add(ctx *gin.Context, req PlanRequest) (plan.Plan, error)

Add creates a new plan in the database

func (*Service) AddValidation

func (s *Service) AddValidation(req PlanRequest) error

AddValidation validates the request to add a plan to the database

func (*Service) Cancel

func (s *Service) Cancel(ctx *gin.Context, id int) error

Cancel cancels a plan in the database Only plans in pending or running state can be cancelled TODO: Notify all workers to stop processing the plan

func (*Service) PaginateList

func (s *Service) PaginateList(ctx *gin.Context) ([]plan.Plan, error)

PaginateList retrieves a paginated list of plan entries from the database

func (*Service) Read

func (s *Service) Read(id int) (plan.Plan, error)

Read retrieves a plan entry from the database

func (*Service) Retry

func (s *Service) Retry(ctx *gin.Context, id int) error

Retry retries a plan in the database