io.micronaut.kubernetes.client.informer

Annotation Type Informer

@Retention(value=RUNTIME)
 @AroundConstruct
 @Prototype
public @interface Informer

Annotation used in combination with ResourceEventHandler will cause the SharedIndexInformer will be created by ResourceEventHandlerConstructorInterceptor.

Since:

3.1

Author:

Pavol Gressa

Field Summary

Fields

Modifier and Type	Fields and Description
static java.lang.String	ALL_NAMESPACES
static java.lang.String	RESOLVE_AUTOMATICALLY

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.Class<? extends io.kubernetes.client.common.KubernetesListObject>	apiListType The resource list type.
java.lang.Class<? extends io.kubernetes.client.common.KubernetesObject>	apiType The resource type.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	apiGroup The watched resource api group.
java.lang.String	labelSelector Informer label selector.
java.lang.Class<? extends java.util.function.Supplier<java.lang.String>>	labelSelectorSupplier Informer label selector supplier.
java.lang.String	namespace Watched resource namespace.
java.lang.String[]	namespaces Watched resource namespaces.
java.lang.Class<? extends java.util.function.Supplier<java.lang.String[]>>	namespacesSupplier Namespaces supplier bean class.
java.lang.String	resourcePlural The watched resource plural.
long	resyncCheckPeriod How often to check if the listener need a resync.

Field Detail

ALL_NAMESPACES

public static final java.lang.String ALL_NAMESPACES

RESOLVE_AUTOMATICALLY

public static final java.lang.String RESOLVE_AUTOMATICALLY

Element Detail

apiType

public abstract java.lang.Class<? extends io.kubernetes.client.common.KubernetesObject> apiType

The resource type.

Returns:

resource type.

apiListType

public abstract java.lang.Class<? extends io.kubernetes.client.common.KubernetesListObject> apiListType

The resource list type.

Returns:

list type

resourcePlural

public abstract java.lang.String resourcePlural

The watched resource plural. For example for V1ConfigMap it is configmaps. To find the proper resource plural visit the Kubernetes API Reference. By default, the api group is automatically evaluated by Discovery.

Returns:

resource plural

Default:

"RESOLVE_AUTOMATICALLY"

apiGroup

public abstract java.lang.String apiGroup

The watched resource api group. For example for V1Job it is batch. To find proper resource api group visit Kubernetes API Reference. By default, the api group is automatically evaluated by Discovery.

Returns:

api group

Default:

"RESOLVE_AUTOMATICALLY"

namespace

public abstract java.lang.String namespace

Watched resource namespace. If empty then namespace is resolved by NamespaceResolver. To watch resources from all namespaces configure this parameter to ALL_NAMESPACES.

Returns:

namespace

Default:

"RESOLVE_AUTOMATICALLY"

namespaces

public abstract java.lang.String[] namespaces

Watched resource namespaces. If empty then namespace is resolved by NamespaceResolver.

Returns:

array of namespace names

Default:

{}

namespacesSupplier

public abstract java.lang.Class<? extends java.util.function.Supplier<java.lang.String[]>> namespacesSupplier

Namespaces supplier bean class.

Returns:

supplier class

Default:

io.micronaut.kubernetes.client.informer.EmptyNamespacesSupplier.class

resyncCheckPeriod

public abstract long resyncCheckPeriod

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

Default:

0L

labelSelector

public abstract java.lang.String labelSelector

Informer label selector.

Returns:

label selector

See Also:

Label selectors

Default:

""

labelSelectorSupplier

public abstract java.lang.Class<? extends java.util.function.Supplier<java.lang.String>> labelSelectorSupplier

Informer label selector supplier.

Returns:

label selector supplier

See Also:

Label selectors

Default:

io.micronaut.kubernetes.client.informer.EmptyLabelSupplier.class