interfaces

Documentation

Overview

Defines an event scheduler interface

Index

• type AddScheduleInput
• type EventScheduler
• type RemoveScheduleInput
• type WorkflowExecutor

Types

type AddScheduleInput

type AddScheduleInput struct {
	// Defines the unique identifier associated with the schedule
	Identifier core.Identifier
	// Defines the schedule expression.
	ScheduleExpression admin.Schedule
	// Message payload encoded as an CloudWatch event rule InputTemplate.
	Payload *string
	// Optional: The application-wide prefix to be applied for schedule names.
	ScheduleNamePrefix string
}

type EventScheduler

type EventScheduler interface {
	// Schedules an event.
	AddSchedule(ctx context.Context, input AddScheduleInput) error

	// CreateScheduleInput using the scheduler config and launch plan identifier and schedule
	CreateScheduleInput(ctx context.Context, appConfig *appInterfaces.SchedulerConfig, identifier core.Identifier,
		schedule *admin.Schedule) (AddScheduleInput, error)

	// Removes an existing schedule.
	RemoveSchedule(ctx context.Context, input RemoveScheduleInput) error
}

type RemoveScheduleInput

type RemoveScheduleInput struct {
	// Defines the unique identifier associated with the schedule
	Identifier core.Identifier
	// Optional: The application-wide prefix to be applied for schedule names.
	ScheduleNamePrefix string
}

type WorkflowExecutor

type WorkflowExecutor interface {
	Run()
	Stop() error
}

Handles responding to scheduled workflow execution events and creating executions.