preprocessing

Documentation

Index

• type Config
  • func (c Config) Validate() error
• type Outcome
• type Task
• type Temporal
• type WorkflowParams
• type WorkflowResult

Types

type Config

type Config struct {
	// Enable preprocessing child workflow.
	Enabled bool
	// Extract package in preprocessing.
	Extract bool
	// Local path shared between workers.
	SharedPath string
	// Temporal configuration.
	Temporal Temporal
}

func (Config) Validate

func (c Config) Validate() error

Validate implements config.ConfigurationValidator.

type Outcome

type Outcome int

const (
	OutcomeSuccess Outcome = iota
	OutcomeSystemError
	OutcomeContentError
)

type Task

type Task struct {
	// Name is the name of the task.
	Name string

	// Message is a human readable description of the task operations or result.
	Message string

	// Outcome indicates the completion state of the task.
	Outcome enums.PreprocessingTaskOutcome

	// StartedAt is the timestamp of the task initiation.
	StartedAt time.Time

	// StartedAt is the timestamp of the task completion.
	CompletedAt time.Time
}

type Temporal

type Temporal struct {
	Namespace    string
	TaskQueue    string
	WorkflowName string
}

type WorkflowParams

type WorkflowParams struct {
	// Relative path to the shared path.
	RelativePath string
}

type WorkflowResult

type WorkflowResult struct {
	// Outcome is an integer indicating if the workflow completed successfully,
	// or with errors.
	Outcome Outcome

	// Relative path to the shared path.
	RelativePath string

	// PreservationTasks is a log of the preservation tasks performed by
	// preprocessing.
	PreservationTasks []Task
}