flux

Documentation

Index

• Constants
• type Commit
  • func GetCommits(meta EventMetadata) []Commit
• type CommitEventMetadata
  • func (cem *CommitEventMetadata) Type() string
• type Event
  • func (e Event) String() string
  • func (e *Event) UnmarshalJSON(in []byte) error
• type EventMetadata
• type ResourceError
  • func GetErrors(meta EventMetadata) []ResourceError
• type SyncEventMetadata
  • func (cem *SyncEventMetadata) Type() string
• type UnknownEventMetadata
  • func (uem UnknownEventMetadata) Type() string

Constants

const (
	EventCommit = "commit"
	EventSync   = "sync"
)

Types

type Commit

type Commit struct {
	Revision string `json:"revision"`
	Message  string `json:"message"`
}

Commit represents the commit information in a sync event. We could use git.Commit, but that would lead to an import cycle, and may anyway represent coupling (of an internal API to serialised data) that we don't want.

func GetCommits

func GetCommits(meta EventMetadata) []Commit

type CommitEventMetadata

type CommitEventMetadata struct {
	Revision string `json:"revision,omitempty"`
}

CommitEventMetadata is the metadata for when new git commits are created

func (*CommitEventMetadata) Type

func (cem *CommitEventMetadata) Type() string

type Event

type Event struct {
	// Type is the type of event, usually "release" for now, but could be other
	// things later
	Type string `json:"type"`

	// Metadata is Event.Type-specific metadata. If an event has no metadata,
	// this will be nil.
	Metadata EventMetadata `json:"metadata,omitempty"`
}

func (Event) String

func (e Event) String() string

func (*Event) UnmarshalJSON

func (e *Event) UnmarshalJSON(in []byte) error

type EventMetadata

type EventMetadata interface {
	Type() string
}

EventMetadata is a type safety trick used to make sure that Metadata field of Event is always a pointer, so that consumers can cast without being concerned about encountering a value type instead. It works by virtue of the fact that the method is only defined for pointer receivers; the actual method chosen is entirely arbitrary.

type ResourceError

type ResourceError struct {
	// ID    ID
	Path  string
	Error string
}

func GetErrors

func GetErrors(meta EventMetadata) []ResourceError

type SyncEventMetadata

type SyncEventMetadata struct {
	Commits []Commit        `json:"commits,omitempty"`
	Errors  []ResourceError `json:"errors,omitempty"`
}

SyncEventMetadata is the metadata for when new a commit is synced to the cluster

func (*SyncEventMetadata) Type

func (cem *SyncEventMetadata) Type() string

type UnknownEventMetadata

type UnknownEventMetadata map[string]interface{}

func (UnknownEventMetadata) Type

func (uem UnknownEventMetadata) Type() string

Special exception from pointer receiver rule, as UnknownEventMetadata is a type alias for a map