event

package
Version: v0.12.2 Latest Latest
Warning

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

Go to latest
Published: Jun 23, 2022 License: Apache-2.0 Imports: 1 Imported by: 1,459

Documentation

Overview

Package event contains the definitions for the Event types produced by source.Sources and transformed into reconcile.Requests by handler.EventHandler.

You should rarely need to work with these directly -- instead, use Controller.Watch with source.Sources and handler.EventHandlers.

Events generally contain both a full runtime.Object that caused the event, as well as a direct handle to that object's metadata. This saves a lot of typecasting in code that works with Events.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CreateEvent

type CreateEvent struct {
	// Object is the object from the event
	Object client.Object
}

CreateEvent is an event where a Kubernetes object was created. CreateEvent should be generated by a source.Source and transformed into a reconcile.Request by an handler.EventHandler.

type DeleteEvent

type DeleteEvent struct {
	// Object is the object from the event
	Object client.Object

	// DeleteStateUnknown is true if the Delete event was missed but we identified the object
	// as having been deleted.
	DeleteStateUnknown bool
}

DeleteEvent is an event where a Kubernetes object was deleted. DeleteEvent should be generated by a source.Source and transformed into a reconcile.Request by an handler.EventHandler.

type GenericEvent

type GenericEvent struct {
	// Object is the object from the event
	Object client.Object
}

GenericEvent is an event where the operation type is unknown (e.g. polling or event originating outside the cluster). GenericEvent should be generated by a source.Source and transformed into a reconcile.Request by an handler.EventHandler.

type UpdateEvent

type UpdateEvent struct {
	// ObjectOld is the object from the event
	ObjectOld client.Object

	// ObjectNew is the object from the event
	ObjectNew client.Object
}

UpdateEvent is an event where a Kubernetes object was updated. UpdateEvent should be generated by a source.Source and transformed into a reconcile.Request by an handler.EventHandler.

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL