package event

import "sigs.k8s.io/controller-runtime/pkg/event"

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 ¶

• type CreateEvent
• type DeleteEvent
• type GenericEvent
• type TypedCreateEvent
• type TypedDeleteEvent
• type TypedGenericEvent
• type TypedUpdateEvent
• type UpdateEvent

Types ¶

type CreateEvent ¶

type CreateEvent = TypedCreateEvent[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 a handler.EventHandler.

type DeleteEvent ¶

type DeleteEvent = TypedDeleteEvent[client.Object]

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 = TypedGenericEvent[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 TypedCreateEvent ¶

type TypedCreateEvent[object any] struct {
	// Object is the object from the event
	Object object

	// IsInInitialList is true if the Create event was triggered by the initial list.
	IsInInitialList bool
}

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

type TypedDeleteEvent ¶

type TypedDeleteEvent[object any] struct {
	// Object is the object from the event
	Object object

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

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

type TypedGenericEvent ¶

type TypedGenericEvent[object any] struct {
	// Object is the object from the event
	Object object
}

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

type TypedUpdateEvent ¶

type TypedUpdateEvent[object any] struct {
	// ObjectOld is the object from the event
	ObjectOld object

	// ObjectNew is the object from the event
	ObjectNew object
}

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

type UpdateEvent ¶

type UpdateEvent = TypedUpdateEvent[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 ¶

doc.go event.go