Package io.micronaut.kubernetes.client.operator

Interface ControllerConfiguration

All Known Implementing Classes:
ControllerConfigurationImpl
public interface ControllerConfiguration
The operator controller configuration.
Since:
3.3
Author:
Pavol Gressa

  • Method Summary

    Modifier and Type
    Method
    Description
    @NonNull String
    getApiGroup()
    The api resource group the operator controller reconciles.
    @NonNull Class<? extends io.kubernetes.client.common.KubernetesListObject>
    getApiListType()
    The api resource list type the operator controller reconciles.
    @NonNull Class<? extends io.kubernetes.client.common.KubernetesObject>
    getApiType()
    The api resource type the operator controller reconciles.
    @NonNull String
    getLabelSelector()
    The operator's informer label selector.
    @NonNull String
    getName()
    The operator controller name.
    @NonNull Set<String>
    getNamespaces()
    The namespaces from which the operator controller receives the resources for reconciliation.
    @Nullable Predicate<? extends io.kubernetes.client.common.KubernetesObject>
    getOnAddFilter()
    Predicate that filters added resources before reconciliation.
    @Nullable BiPredicate<? extends io.kubernetes.client.common.KubernetesObject,Boolean>
    getOnDeleteFilter()
    Predicate that filters deleted resources before reconciliation.
    @Nullable BiPredicate<? extends io.kubernetes.client.common.KubernetesObject,? extends io.kubernetes.client.common.KubernetesObject>
    getOnUpdateFilter()
    Predicate that filters updated resources before reconciliation.
    @NonNull String
    getResourcePlural()
    The api resource plural the operator controller reconciles.
    @NonNull Long
    getResyncCheckPeriod()
    How often to check if the listener need a resync.

  • Method Details

    • getName

      @NonNull @NonNull String getName()
      The operator controller name. The name is used to uniquely identify the operator in the application context.
      Returns:
      name

    • getApiType

      @NonNull @NonNull Class<? extends io.kubernetes.client.common.KubernetesObject> getApiType()
      The api resource type the operator controller reconciles.
      Returns:
      api resource type

    • getApiListType

      @NonNull @NonNull Class<? extends io.kubernetes.client.common.KubernetesListObject> getApiListType()
      The api resource list type the operator controller reconciles.
      Returns:
      api resource list type

    • getResourcePlural

      @NonNull @NonNull String getResourcePlural()
      The api resource plural the operator controller reconciles.
      Returns:
      api resource plural

    • getApiGroup

      @NonNull @NonNull String getApiGroup()
      The api resource group the operator controller reconciles.
      Returns:
      api group

    • getNamespaces

      @NonNull @NonNull Set<String> getNamespaces()
      The namespaces from which the operator controller receives the resources for reconciliation.
      Returns:
      namespaces

    • getLabelSelector

      @NonNull @NonNull String getLabelSelector()
      The operator's informer label selector.
      Returns:
      label selector
      See Also:

    • getResyncCheckPeriod

      @NonNull @NonNull Long getResyncCheckPeriod()
      How often to check if the listener need a resync.
      Returns:
      resync check period, if 0L returned then default minimal resync interval is used
      See Also:
      • DefaultSharedIndexInformer

    • getOnAddFilter

      @Nullable @Nullable Predicate<? extends io.kubernetes.client.common.KubernetesObject> getOnAddFilter()
      Predicate that filters added resources before reconciliation. Default DefaultAddFilter.
      Returns:
      predicate

    • getOnUpdateFilter

      @Nullable @Nullable BiPredicate<? extends io.kubernetes.client.common.KubernetesObject,? extends io.kubernetes.client.common.KubernetesObject> getOnUpdateFilter()
      Predicate that filters updated resources before reconciliation. Default DefaultUpdateFilter.
      Returns:
      bipredicate

    • getOnDeleteFilter

      @Nullable @Nullable BiPredicate<? extends io.kubernetes.client.common.KubernetesObject,Boolean> getOnDeleteFilter()
      Predicate that filters deleted resources before reconciliation. Default DefaultDeleteFilter.
      Returns:
      bipredicate