schedule

Documentation

Overview

Package schedule provides schedule-related API handlers.

Index

• func Handler(logger *slog.Logger, jobClient client.JobClient, signingKey string, ...) []func(e *echo.Echo)
• type Schedule
  • func New(logger *slog.Logger, jobClient client.JobClient) *Schedule
  • func (s *Schedule) DeleteNodeScheduleCron(ctx context.Context, request gen.DeleteNodeScheduleCronRequestObject) (gen.DeleteNodeScheduleCronResponseObject, error)
  • func (s *Schedule) GetNodeScheduleCron(ctx context.Context, request gen.GetNodeScheduleCronRequestObject) (gen.GetNodeScheduleCronResponseObject, error)
  • func (s *Schedule) GetNodeScheduleCronByName(ctx context.Context, request gen.GetNodeScheduleCronByNameRequestObject) (gen.GetNodeScheduleCronByNameResponseObject, error)
  • func (s *Schedule) PostNodeScheduleCron(ctx context.Context, request gen.PostNodeScheduleCronRequestObject) (gen.PostNodeScheduleCronResponseObject, error)
  • func (s *Schedule) PutNodeScheduleCron(ctx context.Context, request gen.PutNodeScheduleCronRequestObject) (gen.PutNodeScheduleCronResponseObject, error)

Functions

func Handler

func Handler(
	logger *slog.Logger,
	jobClient client.JobClient,
	signingKey string,
	customRoles map[string][]string,
) []func(e *echo.Echo)

Handler returns Schedule route registration functions.

Types

type Schedule

type Schedule struct {
	// JobClient provides job-based operations for schedule management.
	JobClient client.JobClient
	// contains filtered or unexported fields
}

Schedule implementation of the Schedule APIs operations.

func New

func New(
	logger *slog.Logger,
	jobClient client.JobClient,
) *Schedule

New factory to create a new instance.

func (*Schedule) DeleteNodeScheduleCron

func (s *Schedule) DeleteNodeScheduleCron(
	ctx context.Context,
	request gen.DeleteNodeScheduleCronRequestObject,
) (gen.DeleteNodeScheduleCronResponseObject, error)

DeleteNodeScheduleCron deletes a cron entry on a target node.

func (*Schedule) GetNodeScheduleCron

func (s *Schedule) GetNodeScheduleCron(
	ctx context.Context,
	request gen.GetNodeScheduleCronRequestObject,
) (gen.GetNodeScheduleCronResponseObject, error)

GetNodeScheduleCron lists all cron entries on a target node.

func (*Schedule) GetNodeScheduleCronByName

func (s *Schedule) GetNodeScheduleCronByName(
	ctx context.Context,
	request gen.GetNodeScheduleCronByNameRequestObject,
) (gen.GetNodeScheduleCronByNameResponseObject, error)

GetNodeScheduleCronByName gets a single cron entry by name on a target node.

func (*Schedule) PostNodeScheduleCron

func (s *Schedule) PostNodeScheduleCron(
	ctx context.Context,
	request gen.PostNodeScheduleCronRequestObject,
) (gen.PostNodeScheduleCronResponseObject, error)

PostNodeScheduleCron creates a cron entry on a target node.

func (*Schedule) PutNodeScheduleCron

func (s *Schedule) PutNodeScheduleCron(
	ctx context.Context,
	request gen.PutNodeScheduleCronRequestObject,
) (gen.PutNodeScheduleCronResponseObject, error)

PutNodeScheduleCron updates a cron entry on a target node.