v9

Documentation

Overview

This package defines the types for Flux API version 9.

Index

• Variables
• type Change
  • func (c *Change) UnmarshalJSON(bs []byte) error
• type ChangeKind
  • func (k ChangeKind) MarshalJSON() ([]byte, error)
• type GitUpdate
• type ImageUpdate
• type Server
• type Upstream

Variables

var ErrUnknownChange = errors.New("unknown kind of change")

Types

type Change

type Change struct {
	Kind   ChangeKind  // essentially a type tag
	Source interface{} // what changed
}

func (*Change) UnmarshalJSON

func (c *Change) UnmarshalJSON(bs []byte) error

type ChangeKind

type ChangeKind string

const (
	GitChange   ChangeKind = "git"
	ImageChange ChangeKind = "image"
)

func (ChangeKind) MarshalJSON

func (k ChangeKind) MarshalJSON() ([]byte, error)

type GitUpdate

type GitUpdate struct {
	URL, Branch string
}

type ImageUpdate

type ImageUpdate struct {
	Name image.Name
}

type Server

type Server interface {
	v6.NotDeprecated
}

type Upstream

type Upstream interface {
	v6.Upstream

	// ChangeNotify tells the daemon that we've noticed a change in
	// e.g., the git repo, or image registry, and now would be a good
	// time to update its state.
	NotifyChange(context.Context, Change) error
}