preheat

Documentation

Index

• Constants
• type Job
  • func (j *Job) MaxCurrency() uint
  • func (j *Job) MaxFails() uint
  • func (j *Job) Run(ctx job.Context, params job.Parameters) error
  • func (j *Job) ShouldRetry() bool
  • func (j *Job) Validate(params job.Parameters) error

Constants

const (
	// PreheatParamProvider is a parameter keeping the preheating provider instance info.
	PreheatParamProvider = "provider"
	// PreheatParamImage is a parameter keeping the preheating artifact (image) info.
	PreheatParamImage = "image"
)

Types

type Job

type Job struct{}

Job preheats the given artifact(image) to the target preheat provider.

func (*Job) MaxCurrency

func (j *Job) MaxCurrency() uint

MaxCurrency indicates no limitation to the concurrency of preheat job.

func (*Job) MaxFails

func (j *Job) MaxFails() uint

MaxFails of preheat job. Don't need to retry.

func (*Job) Run

func (j *Job) Run(ctx job.Context, params job.Parameters) error

Run the preheat process.

func (*Job) ShouldRetry

func (j *Job) ShouldRetry() bool

ShouldRetry indicates no need to retry preheat job as it's just for a cache purpose.

func (*Job) Validate

func (j *Job) Validate(params job.Parameters) error

Validate the parameters of preheat job.