event

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 12, 2022 License: Apache-2.0 Imports: 6 Imported by: 11

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ActionGroup added in v0.26.0 

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

func (ActionGroup) String added in v0.27.0 

func (ag ActionGroup) String() string

String returns a string suitable for logging

type ActionGroupEvent added in v0.26.0 

type ActionGroupEvent struct {
	GroupName string
	Action    ResourceAction
	Status    ActionGroupEventStatus
}

func (ActionGroupEvent) String added in v0.27.0 

func (age ActionGroupEvent) String() string

String returns a string suitable for logging

type ActionGroupEventStatus added in v0.30.0 

type ActionGroupEventStatus int
const (
	Started ActionGroupEventStatus = iota
	Finished
)

func (ActionGroupEventStatus) String added in v0.30.0 

func (i ActionGroupEventStatus) String() string

type ActionGroupList added in v0.27.0 

type ActionGroupList []ActionGroup

func (ActionGroupList) String added in v0.27.0 

func (agl ActionGroupList) String() string

String returns a string suitable for logging

type ApplyEvent 

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

func (ApplyEvent) String added in v0.27.0 

func (ae ApplyEvent) String() string

String returns a string suitable for logging

type ApplyEventStatus added in v0.30.0 

type ApplyEventStatus int
const (
	ApplyPending    ApplyEventStatus = iota // Pending
	ApplySuccessful                         // Successful
	ApplySkipped                            // Skipped
	ApplyFailed                             // Failed
)

func (ApplyEventStatus) String added in v0.30.0 

func (i ApplyEventStatus) String() string

type DeleteEvent added in v0.1.1 

type DeleteEvent struct {
	GroupName  string
	Identifier object.ObjMetadata
	Status     DeleteEventStatus
	Object     *unstructured.Unstructured
	Error      error
}

func (DeleteEvent) String added in v0.27.0 

func (de DeleteEvent) String() string

String returns a string suitable for logging

type DeleteEventStatus added in v0.30.0 

type DeleteEventStatus int
const (
	DeletePending    DeleteEventStatus = iota // Pending
	DeleteSuccessful                          // Successful
	DeleteSkipped                             // Skipped
	DeleteFailed                              // Failed
)

func (DeleteEventStatus) String added in v0.30.0 

func (i DeleteEventStatus) String() string

type ErrorEvent 

type ErrorEvent struct {
	Err error
}

func (ErrorEvent) String added in v0.27.0 

func (ee ErrorEvent) String() string

String returns a string suitable for logging

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

	// WaitEvent contains information about any errors encountered in a WaitTask.
	WaitEvent WaitEvent

	// ValidationEvent contains information about validation errors.
	ValidationEvent ValidationEvent
}

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.

func (Event) String added in v0.27.0 

func (e Event) String() string

String returns a string suitable for logging

type InitEvent added in v0.6.0 

type InitEvent struct {
	ActionGroups ActionGroupList
}

func (InitEvent) String added in v0.27.0 

func (ie InitEvent) String() string

String returns a string suitable for logging

type PruneEvent 

type PruneEvent struct {
	GroupName  string
	Identifier object.ObjMetadata
	Status     PruneEventStatus
	Object     *unstructured.Unstructured
	Error      error
}

func (PruneEvent) String added in v0.27.0 

func (pe PruneEvent) String() string

String returns a string suitable for logging

type PruneEventStatus added in v0.30.0 

type PruneEventStatus int
const (
	PrunePending    PruneEventStatus = iota // Pending
	PruneSuccessful                         // Successful
	PruneSkipped                            // Skipped
	PruneFailed                             // Failed
)

func (PruneEventStatus) String added in v0.30.0 

func (i PruneEventStatus) String() string

type ResourceAction added in v0.6.0 

type ResourceAction int
const (
	ApplyAction     ResourceAction = iota // Apply
	PruneAction                           // Prune
	DeleteAction                          // Delete
	WaitAction                            // Wait
	InventoryAction                       // Inventory
)

func (ResourceAction) String added in v0.6.0 

func (i ResourceAction) String() string

type StatusEvent added in v0.21.0 

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

func (StatusEvent) String added in v0.27.0 

func (se StatusEvent) String() string

String returns a string suitable for logging

type Type 

type Type int

Type determines the type of events that are available. 

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

func (Type) String added in v0.1.1 

func (i Type) String() string

type ValidationEvent added in v0.28.0 

type ValidationEvent struct {
	Identifiers object.ObjMetadataSet
	Error       error
}

func (ValidationEvent) String added in v0.28.0 

func (ve ValidationEvent) String() string

String returns a string suitable for logging

type WaitEvent added in v0.26.1 

type WaitEvent struct {
	GroupName  string
	Identifier object.ObjMetadata
	Status     WaitEventStatus
}

func (WaitEvent) String added in v0.27.0 

func (we WaitEvent) String() string

String returns a string suitable for logging

type WaitEventStatus added in v0.30.0 

type WaitEventStatus int
const (
	ReconcilePending    WaitEventStatus = iota // Pending
	ReconcileSuccessful                        // Successful
	ReconcileSkipped                           // Skipped
	ReconcileTimeout                           // Timeout
	ReconcileFailed                            // Failed
)

func (WaitEventStatus) String added in v0.30.0 

func (i WaitEventStatus) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.