Package io.kubernetes.client.informer.impl

Class DefaultSharedIndexInformer<ApiType extends io.kubernetes.client.common.KubernetesObject,ApiListType extends io.kubernetes.client.common.KubernetesListObject>

java.lang.Object

io.kubernetes.client.informer.impl.DefaultSharedIndexInformer<ApiType,ApiListType>

All Implemented Interfaces:

SharedIndexInformer<ApiType>, SharedInformer<ApiType>

public class DefaultSharedIndexInformer<ApiType extends io.kubernetes.client.common.KubernetesObject,ApiListType extends io.kubernetes.client.common.KubernetesListObject>
extends Object
implements SharedIndexInformer<ApiType>

Constructor Summary

Constructors

Constructor	Description
DefaultSharedIndexInformer(Class<ApiType> apiTypeClass, ListerWatcher<ApiType,ApiListType> listerWatcher, long resyncPeriod)
DefaultSharedIndexInformer(Class<ApiType> apiTypeClass, ListerWatcher<ApiType,ApiListType> listerWatcher, long resyncPeriod, Cache<ApiType> cache)
DefaultSharedIndexInformer(Class<ApiType> apiTypeClass, ListerWatcher<ApiType,ApiListType> listerWatcher, long resyncPeriod, Cache<ApiType> cache, BiConsumer<Class<ApiType>,Throwable> exceptionHandler)
DefaultSharedIndexInformer(Class<ApiType> apiTypeClass, ListerWatcher<ApiType,ApiListType> listerWatcher, long resyncPeriod, DeltaFIFO deltaFIFO, Indexer<ApiType> indexer)
DefaultSharedIndexInformer(Class<ApiType> apiTypeClass, ListerWatcher<ApiType,ApiListType> listerWatcher, long resyncPeriod, DeltaFIFO deltaFIFO, Indexer<ApiType> indexer, BiConsumer<Class<ApiType>,Throwable> exceptionHandler)

Method Summary

Modifier and Type	Method	Description
void	addEventHandler(ResourceEventHandler<ApiType> handler)	add event callback
void	addEventHandlerWithResyncPeriod(ResourceEventHandler<ApiType> handler, long resyncPeriodMillis)	add event callback with a resync period
void	addIndexers(Map<String,Function<ApiType,List<String>>> indexers)	Add indexers.
Indexer	getIndexer()	getIndexer returns the internal indexer store.
void	handleDeltas(Deque<org.apache.commons.lang3.tuple.MutablePair<DeltaFIFO.DeltaType,io.kubernetes.client.common.KubernetesObject>> deltas)	handleDeltas handles deltas and call processor distribute.
boolean	hasSynced()	hasSynced returns true if the shared informer's store has synced.
String	lastSyncResourceVersion()	Last sync resource version string.
void	run()	run starts the shared informer, which will be stopped until stop() is called.
void	setTransform(TransformFunc transformFunc)	The TransformFunc is called for each object which is about to be stored.
void	stop()	stop stops the shared informer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultSharedIndexInformer

public DefaultSharedIndexInformer(Class<ApiType> apiTypeClass,
 ListerWatcher<ApiType,ApiListType> listerWatcher,
 long resyncPeriod)

DefaultSharedIndexInformer

public DefaultSharedIndexInformer(Class<ApiType> apiTypeClass,
 ListerWatcher<ApiType,ApiListType> listerWatcher,
 long resyncPeriod,
 Cache<ApiType> cache)

DefaultSharedIndexInformer

public DefaultSharedIndexInformer(Class<ApiType> apiTypeClass,
 ListerWatcher<ApiType,ApiListType> listerWatcher,
 long resyncPeriod,
 Cache<ApiType> cache,
 BiConsumer<Class<ApiType>,Throwable> exceptionHandler)

DefaultSharedIndexInformer

public DefaultSharedIndexInformer(Class<ApiType> apiTypeClass,
 ListerWatcher<ApiType,ApiListType> listerWatcher,
 long resyncPeriod,
 DeltaFIFO deltaFIFO,
 Indexer<ApiType> indexer)

DefaultSharedIndexInformer

public DefaultSharedIndexInformer(Class<ApiType> apiTypeClass,
 ListerWatcher<ApiType,ApiListType> listerWatcher,
 long resyncPeriod,
 DeltaFIFO deltaFIFO,
 Indexer<ApiType> indexer,
 BiConsumer<Class<ApiType>,Throwable> exceptionHandler)

Method Details

addEventHandler

public void addEventHandler(ResourceEventHandler<ApiType> handler)

add event callback

Specified by:

addEventHandler in interface SharedInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

Parameters:

handler - the handler

addEventHandlerWithResyncPeriod

public void addEventHandlerWithResyncPeriod(ResourceEventHandler<ApiType> handler,
 long resyncPeriodMillis)

add event callback with a resync period

Specified by:

addEventHandlerWithResyncPeriod in interface SharedInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

Parameters:

handler - the event handler

resyncPeriodMillis - the specific resync period

lastSyncResourceVersion

public String lastSyncResourceVersion()

Description copied from interface: SharedInformer

Last sync resource version string.

Specified by:

lastSyncResourceVersion in interface SharedInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

Returns:

the string

setTransform

public void setTransform(TransformFunc transformFunc)

Description copied from interface: SharedInformer

The TransformFunc is called for each object which is about to be stored. This function is intended for you to take the opportunity to remove, transform, or normalize fields. One use case is to strip unused metadata fields out of objects to save on RAM cost.

Must be set before starting the informer.

Note: Since the object given to the handler may be already shared with other goroutines, it is advisable to copy the object being transform before mutating it at all and returning the copy to prevent data races.

Specified by:

setTransform in interface SharedInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

Parameters:

transformFunc - the transform function

run

public void run()

Description copied from interface: SharedInformer

run starts the shared informer, which will be stopped until stop() is called.

Specified by:

run in interface SharedInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

stop

public void stop()

Description copied from interface: SharedInformer

stop stops the shared informer.

Specified by:

stop in interface SharedInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

hasSynced

public boolean hasSynced()

Description copied from interface: SharedInformer

hasSynced returns true if the shared informer's store has synced.

Specified by:

hasSynced in interface SharedInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

handleDeltas

public void handleDeltas(Deque<org.apache.commons.lang3.tuple.MutablePair<DeltaFIFO.DeltaType,io.kubernetes.client.common.KubernetesObject>> deltas)

handleDeltas handles deltas and call processor distribute.

Parameters:

deltas - deltas

addIndexers

public void addIndexers(Map<String,Function<ApiType,List<String>>> indexers)

Description copied from interface: SharedIndexInformer

Add indexers.

Specified by:

addIndexers in interface SharedIndexInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

Parameters:

indexers - the indexers

getIndexer

public Indexer getIndexer()

Description copied from interface: SharedIndexInformer

getIndexer returns the internal indexer store.

Specified by:

getIndexer in interface SharedIndexInformer<ApiType extends io.kubernetes.client.common.KubernetesObject>

Returns:

the internal indexer store