event

package
v0.2.0-alpha.0 Latest Latest
Warning

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

Go to latest
Published: Apr 11, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

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 {
	// Meta is the ObjectMeta of the Kubernetes Type that was created
	Meta metav1.Object

	// Object is the object from the event
	Object runtime.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 {
	// Meta is the ObjectMeta of the Kubernetes Type that was deleted
	Meta metav1.Object

	// Object is the object from the event
	Object runtime.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 {
	// Meta is the ObjectMeta of a Kubernetes Type this event is for
	Meta metav1.Object

	// Object is the object from the event
	Object runtime.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 {
	// MetaOld is the ObjectMeta of the Kubernetes Type that was updated (before the update)
	MetaOld metav1.Object

	// ObjectOld is the object from the event
	ObjectOld runtime.Object

	// MetaNew is the ObjectMeta of the Kubernetes Type that was updated (after the update)
	MetaNew metav1.Object

	// ObjectNew is the object from the event
	ObjectNew runtime.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.

Jump to

Keyboard shortcuts

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