job

package

v4.68.1 Latest Latest Go to latest Published: Apr 30, 2026 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/pixlise/core

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AddJob(idPrefix string, requestorUserId string, jobType protos.JobStatus_JobType, ...) (*protos.JobStatus, error)
func CompleteJob(jobId string, success bool, message string, outputFilePath string, ...) error
func ListenForExternalTriggeredJobs(prefix string, callback func(*protos.JobStatus), db *mongo.Database, ...)
func UpdateJob(jobId string, status protos.JobStatus_Status, message string, logId string, ...) error
type JobConfig
- func (c JobConfig) Copy() JobConfig
type JobFilePath

Constants ¶

This section is empty.

Variables ¶

View Source

var JobConfigEnvVar = "JOB_CONFIG"

Functions ¶

func AddJob ¶

func AddJob(
	idPrefix string,
	requestorUserId string,
	jobType protos.JobStatus_JobType,
	jobItemId string,
	jobName string,
	elementList []string,
	jobTimeoutSec uint32,
	db *mongo.Database,
	idgen idgen.IDGenerator,
	ts timestamper.ITimeStamper,
	logger logger.ILogger,
	sendUpdate func(*protos.JobStatus)) (*protos.JobStatus, error)

func CompleteJob ¶

func CompleteJob(jobId string, success bool, message string, outputFilePath string, otherLogFiles []string, db *mongo.Database, ts timestamper.ITimeStamper, logger logger.ILogger) error

Expected to be called from the thing running the job. This allows setting some output fields

func ListenForExternalTriggeredJobs ¶

func ListenForExternalTriggeredJobs(prefix string, callback func(*protos.JobStatus), db *mongo.Database, logger logger.ILogger)

func UpdateJob ¶

func UpdateJob(jobId string, status protos.JobStatus_Status, message string, logId string, db *mongo.Database, ts timestamper.ITimeStamper, logger logger.ILogger) error

Expected to be called from the thing running the job. This updates the DB status, which hopefully the go thread started by AddJob will notice and fire off an update

Types ¶

type JobConfig ¶ added in v4.68.1

type JobConfig struct {
	// The job id
	JobId string

	// What files are required to be present when running the job?
	RequiredFiles []JobFilePath

	// What command to execute
	Command string
	Args    []string

	// What to upload on completion (if file doesn't exist, it can be ignored with a warning)
	OutputFiles []JobFilePath
}

func (JobConfig) Copy ¶ added in v4.68.1

func (c JobConfig) Copy() JobConfig

type JobFilePath ¶ added in v4.68.1

type JobFilePath struct {
	// The remote file info
	RemoteBucket string
	RemotePath   string

	// Local copy
	LocalPath string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
executor Exposes interfaces and structures required to run PIQUANT in the Kubernetes cluster along with functions to access quantification files, logs, results and summaries of quant jobs.	Exposes interfaces and structures required to run PIQUANT in the Kubernetes cluster along with functions to access quantification files, logs, results and summaries of quant jobs.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL