package
0.18.0
Repository: https://github.com/hashicorp/boundary.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
Package job provides a Job and a Run struct suitable for persisting to the repository.

# Functions

New creates a new Scheduler • serverId must be provided and is the private id of the server that will run the scheduler • jobRepoFn must be provided and is a function that returns the job repository WithRunJobsLimit, WithRunJobsInterval, WithMonitorInterval and WithInterruptThreshold are the only valid options.
TestScheduler creates a mock controller and a new Scheduler attached to that controller id.
WithInterruptThreshold provides an option to provide the duration after which a controller will interrupt a running job that is not updating its status.
WithMonitorInterval provides an option to provide the interval at which the scheduler will query running jobs for status and update the repository accordingly.
WithNextRunIn provides an option to provide the duration until the next run is scheduled.
WithRunJobsInterval provides an option to provide the interval at which the scheduler will query the repository for jobs to run.
WithRunJobsLimit provides an option to provide the number of jobs that will be requested by the scheduler when querying for jobs to run.
WithRunNow provides an option to trigger the scheduling loop after updating the next run time of a specific job.

# Structs

JobStatus defines the struct that must be returned by the Job.Status() method.
Scheduler is used to register and run recurring jobs on the controller.

# Interfaces

Job defines an interface for jobs that can be invoked by the scheduler.

# Type aliases

Option - how Options are passed as arguments.