core

package
v1.8.5-rc1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 1, 2019 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package core provides the main job operation interface and components.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Interface

type Interface interface {
	// LaunchJob is used to handle the job submission request.
	//
	// req	*job.Request    : Job request contains related required information of queuing job.
	//
	// Returns:
	//	job.Stats : Job status info with ID and self link returned if job is successfully launched.
	//  error     : Error returned if failed to launch the specified job.
	LaunchJob(req *job.Request) (*job.Stats, error)

	// GetJob is used to handle the job stats query request.
	//
	// jobID	string: ID of job.
	//
	// Returns:
	//	*job.Stats : Job status info if job exists.
	//  error      : Error returned if failed to get the specified job.
	GetJob(jobID string) (*job.Stats, error)

	// StopJob is used to handle the job stopping request.
	//
	// jobID	string: ID of job.
	//
	// Return:
	//  error   : Error returned if failed to stop the specified job.
	StopJob(jobID string) error

	// RetryJob is used to handle the job retrying request.
	//
	// jobID	string        : ID of job.
	//
	// Return:
	//  error   : Error returned if failed to retry the specified job.
	RetryJob(jobID string) error

	// CheckStatus is used to handle the job service healthy status checking request.
	CheckStatus() (*worker.Stats, error)

	// GetJobLogData is used to return the log text data for the specified job if exists
	GetJobLogData(jobID string) ([]byte, error)

	// Get the periodic executions for the specified periodic job.
	// Pagination by query is supported.
	// The total number is also returned.
	GetPeriodicExecutions(periodicJobID string, query *query.Parameter) ([]*job.Stats, int64, error)

	// Get the jobs with queries.
	//
	// For scheduled jobs, the page number in the query will be ignored, default 20 is used.
	// This is the limitation of backend lib. The int64 is total number.
	// For other cases, query the jobs with cursor, not standard pagination. The int64 is next cursor.
	// The total number is also returned.
	GetJobs(query *query.Parameter) ([]*job.Stats, int64, error)
}

Interface defines the related main methods of job operation.

func NewController

func NewController(backendWorker worker.Interface, mgr mgt.Manager) Interface

NewController is constructor of basicController.

Jump to

Keyboard shortcuts

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