event

Documentation

Index

• type ActionGroup
• type ActionGroupEvent
• type ActionGroupEventType
  • func (i ActionGroupEventType) String() string
• type ApplyEvent
• type ApplyEventOperation
  • func (i ApplyEventOperation) String() string
• type DeleteEvent
• type DeleteEventOperation
  • func (i DeleteEventOperation) String() string
• type ErrorEvent
• type Event
• type InitEvent
• type PruneEvent
• type PruneEventOperation
  • func (i PruneEventOperation) String() string
• type ResourceAction
  • func (i ResourceAction) String() string
• type StatusEvent
• type Type
  • func (i Type) String() string

Types

type ActionGroup

type ActionGroup struct {
	Name        string
	Action      ResourceAction
	Identifiers object.ObjMetadataSet
}

type ActionGroupEvent

type ActionGroupEvent struct {
	GroupName string
	Action    ResourceAction
	Type      ActionGroupEventType
}

type ActionGroupEventType

type ActionGroupEventType int

const (
	Started ActionGroupEventType = iota
	Finished
)

func (ActionGroupEventType) String

func (i ActionGroupEventType) String() string

type ApplyEvent

type ApplyEvent struct {
	GroupName  string
	Identifier object.ObjMetadata
	Operation  ApplyEventOperation
	Resource   *unstructured.Unstructured
	Error      error
}

type ApplyEventOperation

type ApplyEventOperation int

const (
	ApplyUnspecified ApplyEventOperation = iota
	ServersideApplied
	Created
	Unchanged
	Configured
)

func (ApplyEventOperation) String

func (i ApplyEventOperation) String() string

type DeleteEvent

type DeleteEvent struct {
	GroupName  string
	Identifier object.ObjMetadata
	Operation  DeleteEventOperation
	Object     *unstructured.Unstructured
	// If delete is skipped, this reason string explains why
	Reason string
	Error  error
}

type DeleteEventOperation

type DeleteEventOperation int

const (
	DeleteUnspecified DeleteEventOperation = iota
	Deleted
	DeleteSkipped
)

func (DeleteEventOperation) String

func (i DeleteEventOperation) String() string

type ErrorEvent

type ErrorEvent struct {
	Err error
}

type Event

type Event struct {
	// Type is the type of event.
	Type Type

	// InitEvent contains information about which resources will
	// be applied/pruned.
	InitEvent InitEvent

	// ErrorEvent contains information about any errors encountered.
	ErrorEvent ErrorEvent

	// ActionGroupEvent contains information about the progression of tasks
	// to apply, prune, and destroy resources, and tasks that involves waiting
	// for a set of resources to reach a specific state.
	ActionGroupEvent ActionGroupEvent

	// ApplyEvent contains information about progress pertaining to
	// applying a resource to the cluster.
	ApplyEvent ApplyEvent

	// StatusEvents contains information about the status of one of
	// the applied resources.
	StatusEvent StatusEvent

	// PruneEvent contains information about objects that have been
	// pruned.
	PruneEvent PruneEvent

	// DeleteEvent contains information about object that have been
	// deleted.
	DeleteEvent DeleteEvent
}

Event is the type of the objects that will be returned through the channel that is returned from a call to Run. It contains information about progress and errors encountered during the process of doing apply, waiting for status and doing a prune.

type InitEvent

type InitEvent struct {
	ActionGroups []ActionGroup
}

type PruneEvent

type PruneEvent struct {
	GroupName  string
	Identifier object.ObjMetadata
	Operation  PruneEventOperation
	Object     *unstructured.Unstructured
	// If prune is skipped, this reason string explains why
	Reason string
	Error  error
}

type PruneEventOperation

type PruneEventOperation int

const (
	PruneUnspecified PruneEventOperation = iota
	Pruned
	PruneSkipped
)

func (PruneEventOperation) String

func (i PruneEventOperation) String() string

type ResourceAction

type ResourceAction int

const (
	ApplyAction ResourceAction = iota
	PruneAction
	DeleteAction
	WaitAction
	InventoryAction
)

func (ResourceAction) String

func (i ResourceAction) String() string

type StatusEvent

type StatusEvent struct {
	Identifier       object.ObjMetadata
	PollResourceInfo *pollevent.ResourceStatus
	Resource         *unstructured.Unstructured
	Error            error
}

type Type

type Type int

Type determines the type of events that are available.

const (
	InitType Type = iota
	ErrorType
	ActionGroupType
	ApplyType
	StatusType
	PruneType
	DeleteType
)

func (Type) String

func (i Type) String() string