transformer

Documentation

Index

• func IDGenerator(_ context.Context, job *models.Job) error
• type ChainedTransformer
  • func (ct ChainedTransformer[T]) Transform(ctx context.Context, obj T) error
• type GenericTransformer
• type JobDefaults
• type JobFn
  • func (fn JobFn) Transform(ctx context.Context, job *models.Job) error
• type JobTransformer
  • func DefaultPublisher(publisherConfig *models.SpecConfig) JobTransformer
  • func DefaultsApplier(defaults JobDefaults) JobTransformer
  • func NameOptional() JobTransformer
  • func NewInlineStoragePinner(provider storage.StorageProvider) JobTransformer
  • func RequesterInfo(requesterNodeID string) JobTransformer
• type ResultFn
  • func (fn ResultFn) Transform(ctx context.Context, result *models.SpecConfig) error
• type ResultTransformer

Functions

func IDGenerator

func IDGenerator(_ context.Context, job *models.Job) error

IDGenerator is a transformer that generates a new ID for the job if it is empty.

Types

type ChainedTransformer

type ChainedTransformer[T any] []GenericTransformer[T]

ChainedTransformer is a slice of Transformers that runs in sequence

func (ChainedTransformer[T]) Transform

func (ct ChainedTransformer[T]) Transform(ctx context.Context, obj T) error

Transform runs all transformers in sequence.

type GenericTransformer

type GenericTransformer[T any] interface {
	Transform(context.Context, T) error
}

GenericTransformer is an interface that can be used to modify an object in place.

type JobDefaults

type JobDefaults struct {
	ExecutionTimeout time.Duration
}

type JobFn

type JobFn func(context.Context, *models.Job) error

JobFn is a function that implements JobTransformer transform interface.

func (JobFn) Transform

func (fn JobFn) Transform(ctx context.Context, job *models.Job) error

type JobTransformer

type JobTransformer interface {
	GenericTransformer[*models.Job]
}

JobTransformer is an interface that can be used to modify a job in place, such as setting default values or migrating.

func DefaultPublisher

func DefaultPublisher(publisherConfig *models.SpecConfig) JobTransformer

func DefaultsApplier

func DefaultsApplier(defaults JobDefaults) JobTransformer

DefaultsApplier is a transformer that applies default values to the job.

func NameOptional

func NameOptional() JobTransformer

NameOptional is a transformer that sets the job name to the job ID if it is empty.

func NewInlineStoragePinner

func NewInlineStoragePinner(provider storage.StorageProvider) JobTransformer

NewInlineStoragePinner returns a job transformer that limits the inline space taken up by inline data. It will scan a job for StorageSpec objects that store their data inline and move any that are too large into IPFS storage. It also limits the total size taken up by inline specs and if this value is exceeded it will move the largest specs into IPFS.

func RequesterInfo

func RequesterInfo(requesterNodeID string) JobTransformer

RequesterInfo is a transformer that sets the requester ID in the job meta.

type ResultFn

type ResultFn func(context.Context, *models.SpecConfig) error

ResultFn is a function that implements ResultTransformer transform interface.

func (ResultFn) Transform

func (fn ResultFn) Transform(ctx context.Context, result *models.SpecConfig) error

type ResultTransformer

type ResultTransformer interface {
	GenericTransformer[*models.SpecConfig]
}

ResultTransformer is an interface that can be used to modify a result in place.