states

Documentation

Index

• Variables
• func IsTerminal(state State) bool
• type State
  • func (s State) IsOneOf(targets ...State) bool

Variables

var ErrInvalidState = errors.New("invalid state given")

ErrInvalidState is the error returned when a given state does not exist in the state space for any job type.

Functions

func IsTerminal

func IsTerminal(state State) bool

IsTerminal returns true if the provided state is terminal.

Types

type State

type State string

The State type's inhabitants comprise a job's state space.

const (
	// Pending In this state, a job has been created, but its sub-resources are pending.
	Pending State = "Pending"

	// Running This is the _ready_ state for a job.
	// In this state, it is running as expected.
	Running State = "Running"

	// Completed A `Completed` job has been undeployed. `Completed` is a terminal state.
	Completed State = "Completed"

	// Failed A job is in an `Failed` state if an error has caused it to no longer be running as expected.
	Failed State = "Failed"
)

func (State) IsOneOf

func (s State) IsOneOf(targets ...State) bool

IsOneOf returns true if this state is in the supplied list.