presentation

Documentation

Overview

Package presentation implements common method to API and UI serving.

Index

• func GetJobTraits(ctx context.Context, cat catalog.Catalog, j *engine.Job) (task.Traits, error)
• type PublicStateKind
  • func GetPublicStateKind(j *engine.Job, traits task.Traits) PublicStateKind

Functions

func GetJobTraits

func GetJobTraits(ctx context.Context, cat catalog.Catalog, j *engine.Job) (task.Traits, error)

GetJobTraits asks the corresponding task manager for a traits struct.

Types

type PublicStateKind

type PublicStateKind string

PublicStateKind defines state of the job which is exposed in UI and API instead of internal states which are kept as an implementation detail.

const (
	PublicStateDisabled  PublicStateKind = "DISABLED"
	PublicStatePaused    PublicStateKind = "PAUSED"
	PublicStateRunning   PublicStateKind = "RUNNING"
	PublicStateScheduled PublicStateKind = "SCHEDULED"
	PublicStateWaiting   PublicStateKind = "WAITING"
)

When a PublicStateKind is added/removed/updated, update scheduler api proto doc for `JobState`.

func GetPublicStateKind

func GetPublicStateKind(j *engine.Job, traits task.Traits) PublicStateKind

GetPublicStateKind returns user-friendly state for a job.