Documentation
¶
Overview ¶
Package event contains the event structure to encapsulate what is happening during the client apply process. the events can be used to log the status directly to the user or cancelling the excution if some error is found.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ApplyInfo ¶
type ApplyInfo struct {
Object *unstructured.Unstructured
Status Status
Error error
}
type Event ¶
type Event struct {
Type Type
// ErrorInfo contains info for a TypeError event
ErrorInfo ErrorInfo
// QueueInfo contains info for a TypeQueue event
QueueInfo QueueInfo
// ApplyInfo contains info for a TypeApply event
ApplyInfo ApplyInfo
// PruneInfo contains info for a PruneInfo event
PruneInfo PruneInfo
// InventoryInfo contains info for a TypeInventory event
InventoryInfo InventoryInfo
// StatusUpdateInfo contains info for a TypeStatusUpdate event
StatusUpdateInfo StatusUpdateInfo
}
Event is the basic block for encapsulate the progression of a task or queue during its execution, more state can be encapsulated extending this struct but
func (Event) IsErrorEvent ¶
IsErrorEvent can be used to check if the error contains some type of error
type InventoryInfo ¶
func (InventoryInfo) String ¶
func (i InventoryInfo) String() string
type PruneInfo ¶
type PruneInfo struct {
Object *unstructured.Unstructured
Status Status
Error error
}
type QueueInfo ¶
type QueueInfo struct {
Objects []*unstructured.Unstructured
}
type StatusUpdateInfo ¶
type StatusUpdateInfo struct {
Status Status
Message string
ObjectMetadata resource.ObjectMetadata
}
func (StatusUpdateInfo) String ¶
func (i StatusUpdateInfo) String() string
Click to show internal directories.
Click to hide internal directories.