Merge pull request kubernetes-sigs#2796 from alvaroaleman/mark

📖  Mark Typed Handlers as experimental

Author: k8s-ci-robot

pkg/handler/enqueue.go

@@ -42,6 +42,8 @@ type EnqueueRequestForObject = TypedEnqueueRequestForObject[client.Object]
 // TypedEnqueueRequestForObject enqueues a Request containing the Name and Namespace of the object that is the source of the Event.
 // (e.g. the created / deleted / updated objects Name and Namespace).  handler.TypedEnqueueRequestForObject is used by almost all
 // Controllers that have associated Resources (e.g. CRDs) to reconcile the associated Resource.
+//
+// TypedEnqueueRequestForObject is experimental and subject to future change.
 type TypedEnqueueRequestForObject[T client.Object] struct{}
 
 // Create implements EventHandler.

pkg/handler/enqueue_mapped.go

@@ -31,6 +31,8 @@ type MapFunc = TypedMapFunc[client.Object]
 
 // TypedMapFunc is the signature required for enqueueing requests from a generic function.
 // This type is usually used with EnqueueRequestsFromTypedMapFunc when registering an event handler.
+//
+// TypedMapFunc is experimental and subject to future change.
 type TypedMapFunc[T any] func(context.Context, T) []reconcile.Request
 
 // EnqueueRequestsFromMapFunc enqueues Requests by running a transformation function that outputs a collection
@@ -57,6 +59,8 @@ func EnqueueRequestsFromMapFunc(fn MapFunc) EventHandler {
 //
 // For TypedUpdateEvents which contain both a new and old object, the transformation function is run on both
 // objects and both sets of Requests are enqueue.
+//
+// TypedEnqueueRequestsFromMapFunc is experimental and subject to future change.
 func TypedEnqueueRequestsFromMapFunc[T any](fn TypedMapFunc[T]) TypedEventHandler[T] {
 	return &enqueueRequestsFromMapFunc[T]{
 		toRequests: fn,

pkg/handler/enqueue_owner.go

@@ -59,6 +59,8 @@ func EnqueueRequestForOwner(scheme *runtime.Scheme, mapper meta.RESTMapper, owne
 // - a source.Kind Source with Type of Pod.
 //
 // - a handler.typedEnqueueRequestForOwner EventHandler with an OwnerType of ReplicaSet and OnlyControllerOwner set to true.
+//
+// TypedEnqueueRequestForOwner is experimental and subject to future change.
 func TypedEnqueueRequestForOwner[T client.Object](scheme *runtime.Scheme, mapper meta.RESTMapper, ownerType client.Object, opts ...OwnerOption) TypedEventHandler[T] {
 	e := &enqueueRequestForOwner[T]{
 		ownerType: ownerType,

pkg/handler/eventhandler.go

@@ -62,6 +62,8 @@ type EventHandler TypedEventHandler[client.Object]
 //
 // Unless you are implementing your own TypedEventHandler, you can ignore the functions on the TypedEventHandler interface.
 // Most users shouldn't need to implement their own TypedEventHandler.
+//
+// TypedEventHandler is experimental and subject to future change.
 type TypedEventHandler[T any] interface {
 	// Create is called in response to a create event - e.g. Pod Creation.
 	Create(context.Context, event.TypedCreateEvent[T], workqueue.RateLimitingInterface)
@@ -83,6 +85,8 @@ var _ EventHandler = Funcs{}
 type Funcs = TypedFuncs[client.Object]
 
 // TypedFuncs implements eventhandler.
+//
+// TypedFuncs is experimental and subject to future change.
 type TypedFuncs[T any] struct {
 	// Create is called in response to an add event.  Defaults to no-op.
 	// RateLimitingInterface is used to enqueue reconcile.Requests.