job

Documentation

Index

• func FromCells(cells []dataselect.DataCell) []batch.Job
• func GetJobEvents(client client.Interface, dsQuery *dataselect.DataSelectQuery, ...) (*common.EventList, error)
• func ToCells(std []batch.Job) []dataselect.DataCell
• type Job
• type JobCell
  • func (self JobCell) GetProperty(name dataselect.PropertyName) dataselect.ComparableValue
• type JobDetail
  • func GetJobDetail(client k8sClient.Interface, namespace, name string) (*JobDetail, error)
• type JobList
  • func GetJobList(client client.Interface, nsQuery *common.NamespaceQuery, ...) (*JobList, error)
  • func GetJobListFromChannels(channels *common.ResourceChannels, dsQuery *dataselect.DataSelectQuery) (*JobList, error)
  • func ToJobList(jobs []batch.Job, pods []v1.Pod, events []v1.Event, nonCriticalErrors []error, ...) *JobList
• type JobStatus
• type JobStatusType

Functions

func FromCells

func FromCells(cells []dataselect.DataCell) []batch.Job

FromCells converts a slice of DataCells to a slice of Jobs.

func GetJobEvents

func GetJobEvents(client client.Interface, dsQuery *dataselect.DataSelectQuery, namespace, name string) (
	*common.EventList, error)

GetJobEvents gets events associated to job.

func ToCells

func ToCells(std []batch.Job) []dataselect.DataCell

ToCells converts a slice of Jobs to a slice of DataCells.

Types

type Job

type Job struct {
	ObjectMeta types.ObjectMeta `json:"objectMeta"`
	TypeMeta   types.TypeMeta   `json:"typeMeta"`

	// Aggregate information about pods belonging to this Job.
	Pods common.PodInfo `json:"podInfo"`

	// Container images of the Job.
	ContainerImages []string `json:"containerImages"`

	// Init Container images of the Job.
	InitContainerImages []string `json:"initContainerImages"`

	// number of parallel jobs defined.
	Parallelism *int32 `json:"parallelism"`

	// JobStatus contains inferred job status based on job conditions
	JobStatus JobStatus `json:"jobStatus"`
}

Job is a presentation layer view of Kubernetes Job resource. This means it is Job plus additional augmented data we can get from other sources

type JobCell

type JobCell batch.Job

JobCell represents a job cell that implements the DataCell interface.

func (JobCell) GetProperty

func (self JobCell) GetProperty(name dataselect.PropertyName) dataselect.ComparableValue

GetProperty returns a comparable value for a specified property name.

type JobDetail

type JobDetail struct {
	// Extends list item structure.
	Job `json:",inline"`

	// Completions specifies the desired number of successfully finished pods the job should be run with.
	Completions *int32 `json:"completions"`

	// List of non-critical errors, that occurred during resource retrieval.
	Errors []error `json:"errors"`
}

JobDetail is a presentation layer view of Kubernetes Job resource.

func GetJobDetail

func GetJobDetail(client k8sClient.Interface, namespace, name string) (*JobDetail, error)

GetJobDetail gets job details.

type JobList

type JobList struct {
	ListMeta types.ListMeta `json:"listMeta"`

	// Basic information about resources status on the list.
	Status common.ResourceStatus `json:"status"`

	// Unordered list of Jobs.
	Jobs []Job `json:"jobs"`

	// List of non-critical errors, that occurred during resource retrieval.
	Errors []error `json:"errors"`
}

JobList contains a list of Jobs in the cluster.

func GetJobList

func GetJobList(client client.Interface, nsQuery *common.NamespaceQuery,
	dsQuery *dataselect.DataSelectQuery) (*JobList, error)

GetJobList returns a list of all Jobs in the cluster.

func GetJobListFromChannels

func GetJobListFromChannels(channels *common.ResourceChannels, dsQuery *dataselect.DataSelectQuery) (*JobList, error)

GetJobListFromChannels returns a list of all Jobs in the cluster reading required resource list once from the channels.

func ToJobList

func ToJobList(jobs []batch.Job, pods []v1.Pod, events []v1.Event, nonCriticalErrors []error,
	dsQuery *dataselect.DataSelectQuery) *JobList

type JobStatus

type JobStatus struct {
	// Short, machine understandable job status code.
	Status JobStatusType `json:"status"`
	// A human-readable description of the status of related job.
	Message string `json:"message"`
	// Conditions describe the state of a job after it finishes.
	Conditions []common.Condition `json:"conditions"`
}

type JobStatusType

type JobStatusType string

const (
	// JobStatusRunning means the job is still running.
	JobStatusRunning JobStatusType = "Running"
	// JobStatusComplete means the job has completed its execution.
	JobStatusComplete JobStatusType = "Complete"
	// JobStatusFailed means the job has failed its execution.
	JobStatusFailed JobStatusType = "Failed"
)