event.go

/*
Copyright 2018 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package event

import (
	"k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/runtime"
)

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

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

	// ObjectNew is the object from the event
	ObjectNew runtime.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 DeleteEvent struct {
	// Meta is the ObjectMeta of the Kubernetes Type that was deleted
	Meta v1.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
}

// 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 GenericEvent struct {
	// Meta is the ObjectMeta of a Kubernetes Type this event is for
	Meta v1.Object

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