event

Documentation

Index

• Constants
• Variables
• func IsEventDiscarded(err error) bool
• type Event
  • func FromWire(pev *pb.CloudEvent) (*Event, error)
  • func (ev Event) AppProject() (*v1alpha1.AppProject, error)
  • func (ev Event) Application() (*v1alpha1.Application, error)
  • func (ev Event) Target() EventTarget
  • func (ev Event) Type() EventType
• type EventSource
  • func NewEventSource(source string) *EventSource
  • func (evs EventSource) AppProjectEvent(evType EventType, appProject *v1alpha1.AppProject) *cloudevents.Event
  • func (evs EventSource) ApplicationEvent(evType EventType, app *v1alpha1.Application) *cloudevents.Event
• type EventTarget
  • func Target(raw *cloudevents.Event) EventTarget
  • func (t EventTarget) String() string
• type EventType
  • func (t EventType) String() string

Constants

const TypePrefix = "io.argoproj.argocd-agent.event"

Variables

var (
	ErrEventDiscarded  error = errors.New("event discarded")
	ErrEventNotAllowed error = errors.New("event not allowed in this agent mode")
)

Functions

func IsEventDiscarded

func IsEventDiscarded(err error) bool

Types

type Event

type Event struct {
	// contains filtered or unexported fields
}

Event is the 'on the wire' representation of an event, and is parsed by from protobuf via FromWire

func FromWire

func FromWire(pev *pb.CloudEvent) (*Event, error)

FromWire validates an event from the wire in protobuf format, converts it into an Event object and returns it. If the event on the wire is invalid, or could not be converted for another reason, FromWire returns an error.

func (Event) AppProject

func (ev Event) AppProject() (*v1alpha1.AppProject, error)

func (Event) Application

func (ev Event) Application() (*v1alpha1.Application, error)

func (Event) Target

func (ev Event) Target() EventTarget

func (Event) Type

func (ev Event) Type() EventType

type EventSource

type EventSource struct {
	// contains filtered or unexported fields
}

EventSource is a utility to construct new 'cloudevents.Event' events for a given 'source'

func NewEventSource

func NewEventSource(source string) *EventSource

func (EventSource) AppProjectEvent

func (evs EventSource) AppProjectEvent(evType EventType, appProject *v1alpha1.AppProject) *cloudevents.Event

func (EventSource) ApplicationEvent

func (evs EventSource) ApplicationEvent(evType EventType, app *v1alpha1.Application) *cloudevents.Event

type EventTarget

type EventTarget string

const (
	TargetUnknown     EventTarget = "unknown"
	TargetApplication EventTarget = "application"
	TargetAppProject  EventTarget = "appproject"
)

func Target

func Target(raw *cloudevents.Event) EventTarget

func (EventTarget) String

func (t EventTarget) String() string

type EventType

type EventType string

const (
	Ping            EventType = TypePrefix + ".ping"
	Pong            EventType = TypePrefix + ".pong"
	Create          EventType = TypePrefix + ".create"
	Delete          EventType = TypePrefix + ".delete"
	Update          EventType = TypePrefix + ".update"
	SpecUpdate      EventType = TypePrefix + ".spec-update"
	StatusUpdate    EventType = TypePrefix + ".status-update"
	OperationUpdate EventType = TypePrefix + ".operation-update"
)

Supported EventTypes that are sent agent <-> principal

func (EventType) String

func (t EventType) String() string