io.kubernetes.client.informer.cache

Class Cache<ApiType>

java.lang.Object

io.kubernetes.client.informer.cache.Cache<ApiType>

All Implemented Interfaces:

Indexer<ApiType>, Store<ApiType>

public class Cache<ApiType>
extends java.lang.Object
implements Indexer<ApiType>

Cache is a java port of k/client-go's ThreadSafeStore. It basically saves and indexes all the entries.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	NAMESPACE_INDEX Deprecated.

Constructor Summary

Constructors

Constructor and Description
Cache()
Cache(java.lang.String indexName, java.util.function.Function<ApiType,java.util.List<java.lang.String>> indexFunc, java.util.function.Function<ApiType,java.lang.String> keyFunc) Constructor.

Method Summary

Modifier and Type	Method and Description
void	add(ApiType obj) Add objects.
void	addIndexers(java.util.Map<java.lang.String,java.util.function.Function<ApiType,java.util.List<java.lang.String>>> newIndexers) Add additional indexers to the cache.
void	addIndexFunc(java.lang.String indexName, java.util.function.Function<ApiType,java.util.List<java.lang.String>> indexFunc) Add index func.
java.util.List<ApiType>	byIndex(java.lang.String indexName, java.lang.String indexKey) By index list.
void	delete(ApiType obj) Delete the object.
static <ApiType> java.lang.String	deletionHandlingMetaNamespaceKeyFunc(ApiType object) Deprecated.
ApiType	get(ApiType obj) Get object t.
ApiType	getByKey(java.lang.String key) Gets get by key.
java.util.Map<java.lang.String,java.util.function.Function<ApiType,java.util.List<java.lang.String>>>	getIndexers() Return the indexers registered with the cache.
java.util.function.Function<ApiType,java.lang.String>	getKeyFunc()
java.util.List<ApiType>	index(java.lang.String indexName, java.lang.Object obj) Get objects .
java.util.List<java.lang.String>	indexKeys(java.lang.String indexName, java.lang.String indexKey) Index keys list.
java.util.List<ApiType>	list() List all objects in the cache.
java.util.List<java.lang.String>	listKeys() List keys.
static java.util.List<java.lang.String>	metaNamespaceIndexFunc(java.lang.Object obj) Deprecated.
static java.lang.String	metaNamespaceKeyFunc(java.lang.Object obj) Deprecated.
void	replace(java.util.List<ApiType> list, java.lang.String resourceVersion) Replace the content in the cache completely.
void	resync() Resync.
void	setKeyFunc(java.util.function.Function<ApiType,java.lang.String> keyFunc)
void	update(ApiType obj) Update the object.
void	updateIndices(ApiType oldObj, ApiType newObj, java.lang.String key) updateIndices modifies the objects location in the managed indexes, if this is an update, you must provide an oldObj.

Methods inherited from class java.lang.Object

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

Field Detail

NAMESPACE_INDEX

@Deprecated
public static final java.lang.String NAMESPACE_INDEX

Deprecated.

DEPRECATE: use Caches#NAMESPACE_INDEX instead. TODO: remove after 7.0.0

NAMESPACE_INDEX is the default index function for caching objects

See Also:

Constant Field Values

Constructor Detail

Cache

public Cache()

Cache

public Cache(java.lang.String indexName,
             java.util.function.Function<ApiType,java.util.List<java.lang.String>> indexFunc,
             java.util.function.Function<ApiType,java.lang.String> keyFunc)

Constructor.

Parameters:

indexName - the index name, an unique name representing the index

indexFunc - the index func by which we map multiple object to an index for querying

keyFunc - the key func by which we map one object to an unique key for storing

Method Detail

add

public void add(ApiType obj)

Add objects.

Specified by:

add in interface Store<ApiType>

Parameters:

obj - the obj

update

public void update(ApiType obj)

Update the object.

Specified by:

update in interface Store<ApiType>

Parameters:

obj - the obj

delete

public void delete(ApiType obj)

Delete the object.

Specified by:

delete in interface Store<ApiType>

Parameters:

obj - the obj

replace

public void replace(java.util.List<ApiType> list,
                    java.lang.String resourceVersion)

Replace the content in the cache completely.

Specified by:

replace in interface Store<ApiType>

Parameters:

list - the list

resourceVersion - the resource version

resync

public void resync()

Resync.

Specified by:

resync in interface Store<ApiType>

listKeys

public java.util.List<java.lang.String> listKeys()

List keys.

Specified by:

listKeys in interface Store<ApiType>

Returns:

the list

get

public ApiType get(ApiType obj)

Get object t.

Specified by:

get in interface Store<ApiType>

Parameters:

obj - the obj

Returns:

the t

list

public java.util.List<ApiType> list()

List all objects in the cache.

Specified by:

list in interface Store<ApiType>

Returns:

the list

getByKey

public ApiType getByKey(java.lang.String key)

Gets get by key.

Specified by:

getByKey in interface Store<ApiType>

Parameters:

key - the key

Returns:

the get by key

index

public java.util.List<ApiType> index(java.lang.String indexName,
                                     java.lang.Object obj)

Get objects .

Specified by:

index in interface Indexer<ApiType>

Parameters:

indexName - the index name

obj - the obj

Returns:

the list

indexKeys

public java.util.List<java.lang.String> indexKeys(java.lang.String indexName,
                                                  java.lang.String indexKey)

Index keys list.

Specified by:

indexKeys in interface Indexer<ApiType>

Parameters:

indexName - the index name

indexKey - the index key

Returns:

the list

byIndex

public java.util.List<ApiType> byIndex(java.lang.String indexName,
                                       java.lang.String indexKey)

By index list.

Specified by:

byIndex in interface Indexer<ApiType>

Parameters:

indexName - the index name

indexKey - the index key

Returns:

the list

getIndexers

public java.util.Map<java.lang.String,java.util.function.Function<ApiType,java.util.List<java.lang.String>>> getIndexers()

Return the indexers registered with the cache.

Specified by:

getIndexers in interface Indexer<ApiType>

Returns:

registered indexers

addIndexers

public void addIndexers(java.util.Map<java.lang.String,java.util.function.Function<ApiType,java.util.List<java.lang.String>>> newIndexers)

Add additional indexers to the cache.

Specified by:

addIndexers in interface Indexer<ApiType>

Parameters:

newIndexers - indexers to add

updateIndices

public void updateIndices(ApiType oldObj,
                          ApiType newObj,
                          java.lang.String key)

updateIndices modifies the objects location in the managed indexes, if this is an update, you must provide an oldObj.

Note: updateIndices must be called from a function that already has a lock on the cache.

Parameters:

oldObj - the old obj

newObj - the new obj

key - the key

addIndexFunc

public void addIndexFunc(java.lang.String indexName,
                         java.util.function.Function<ApiType,java.util.List<java.lang.String>> indexFunc)

Add index func.

Parameters:

indexName - the index name

indexFunc - the index func

getKeyFunc

public java.util.function.Function<ApiType,java.lang.String> getKeyFunc()

setKeyFunc

public void setKeyFunc(java.util.function.Function<ApiType,java.lang.String> keyFunc)

deletionHandlingMetaNamespaceKeyFunc

@Deprecated
public static <ApiType> java.lang.String deletionHandlingMetaNamespaceKeyFunc(ApiType object)

Deprecated.

DEPRECATE: use Caches#deletionHandlingMetaNamespaceKeyFunc instead. TODO: remove after 7.0.0

deletionHandlingMetaNamespaceKeyFunc checks for DeletedFinalStateUnknown objects before calling metaNamespaceKeyFunc.

Type Parameters:

ApiType - the type parameter

Parameters:

object - specific object

Returns:

the key

metaNamespaceKeyFunc

@Deprecated
public static java.lang.String metaNamespaceKeyFunc(java.lang.Object obj)

Deprecated.

DEPRECATE: use Caches#metaNamespaceKeyFunc instead. TODO: remove after 7.0.0

MetaNamespaceKeyFunc is a convenient default KeyFunc which knows how to make keys for API objects which implement HasMetadata Interface. The key uses the format / unless is empty, then it's just .

Parameters:

obj - specific object

Returns:

the key

metaNamespaceIndexFunc

@Deprecated
public static java.util.List<java.lang.String> metaNamespaceIndexFunc(java.lang.Object obj)

Deprecated.

DEPRECATE: use Caches#metaNamespaceIndexFunc instead. TODO: remove after 7.0.0

metaNamespaceIndexFunc is a default index function that indexes based on an object's namespace.

Parameters:

obj - specific object

Returns:

the indexed value