Package io.micronaut.kubernetes.client.openapi.operator

Annotation Interface Operator

@Retention(RUNTIME) @Target({TYPE,ANNOTATION_TYPE}) @Bean @DefaultScope(io.micronaut.context.annotation.Context.class) public @interface Operator
Operator annotation simplifies initialisation of the controllers.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    io.micronaut.kubernetes.client.openapi.informer.handler.Informer
    informer
    The informer which is used to watch and report resource changes.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    The name of the operator.
    Class<? extends Predicate<? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject>>
    onAddFilter
    The class of the filter applied by informer's resource handler when a new resource is created.
    Class<? extends BiPredicate<? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject,Boolean>>
    onDeleteFilter
    The class of the filter applied by informer's resource handler when an existing resource is deleted.
    Class<? extends BiPredicate<? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject,? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject>>
    onUpdateFilter
    The class of the filter applied by informer's resource handler when an existing resource is updated.

  • Element Details

    • informer

      io.micronaut.kubernetes.client.openapi.informer.handler.Informer informer
      The informer which is used to watch and report resource changes.
      Returns:
      the informer instance

    • name

      String name
      The name of the operator. It is used to uniquely identify the created controller. If not provided the controller name is generated.
      Returns:
      operator name
      Default:
      ""

    • onAddFilter

      Class<? extends Predicate<? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject>> onAddFilter
      The class of the filter applied by informer's resource handler when a new resource is created.
      Returns:
      filter class
      Default:
      io.micronaut.kubernetes.client.openapi.operator.OperatorFilter.OnAdd.class

    • onUpdateFilter

      Class<? extends BiPredicate<? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject,? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject>> onUpdateFilter
      The class of the filter applied by informer's resource handler when an existing resource is updated.
      Returns:
      filter class
      Default:
      io.micronaut.kubernetes.client.openapi.operator.OperatorFilter.OnUpdate.class

    • onDeleteFilter

      Class<? extends BiPredicate<? extends io.micronaut.kubernetes.client.openapi.common.KubernetesObject,Boolean>> onDeleteFilter
      The class of the filter applied by informer's resource handler when an existing resource is deleted.
      Returns:
      filter class
      Default:
      io.micronaut.kubernetes.client.openapi.operator.OperatorFilter.OnDelete.class