Class Cache<ApiType extends KubernetesObject>

java.lang.Object

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

Type Parameters:

ApiType - kubernetes api type

All Implemented Interfaces:

Indexer<ApiType>, Store<ApiType>

@Internal
public final class Cache<ApiType extends KubernetesObject>
extends Object
implements Indexer<ApiType>

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

The code has been copied from the official client and modified: Cache

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_GLOBAL_INDEX_KEY
static final String	DEFAULT_INDEX_NAME

Constructor Summary

Constructors

Constructor	Description
Cache()
Cache(Function<ApiType,String> keyFunction)
Cache(Function<ApiType,String> keyFunction, Map<String, Function<ApiType, List<String>>> indexFunctions)
Cache(Map<String, Function<ApiType, List<String>>> indexFunctions)

Method Summary

Modifier and Type	Method	Description
void	add(ApiType object)	Inserts an item into the store.
List<ApiType>	byIndex(String indexName, String indexKey)	Returns a list of objects by index name and index key.
void	delete(ApiType object)	Removes an item from the store.
ApiType	getByKey(String key)	Returns the request item with specific key.
Map<String, Function<ApiType, List<String>>>	getIndexers()	Return the indexers registered with the store.
Function<ApiType,String>	getKeyFunction()	Returns a function which creates an object key.
List<String>	indexKeys(String indexName, String indexKey)	Returns a list of object keys by index name and index key.
List<ApiType>	list()	Returns a list of all the items.
List<String>	listKeys()	Returns a list of keys of all objects that are currently in the store.
void	replace(List<ApiType> objects)	Replace the content in the cache completely.
void	update(ApiType object)	Sets an item in the store to its updated state.

Methods inherited from class Object

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

Field Details

DEFAULT_INDEX_NAME

public static final String DEFAULT_INDEX_NAME

See Also:

• Constant Field Values

DEFAULT_GLOBAL_INDEX_KEY

public static final String DEFAULT_GLOBAL_INDEX_KEY

See Also:

• Constant Field Values

Constructor Details

Cache

public Cache()

Cache

public Cache(Function<ApiType,String> keyFunction)

Cache

public Cache(Map<String, Function<ApiType, List<String>>> indexFunctions)

Cache

public Cache(Function<ApiType,String> keyFunction,
 Map<String, Function<ApiType, List<String>>> indexFunctions)

Method Details

getKeyFunction

public Function<ApiType,String> getKeyFunction()

Description copied from interface: Store

Returns a function which creates an object key.

Specified by:

getKeyFunction in interface Store<ApiType extends KubernetesObject>

Returns:

function which creates an object key

add

public void add(ApiType object)

Description copied from interface: Store

Inserts an item into the store.

Specified by:

add in interface Store<ApiType extends KubernetesObject>

Parameters:

object - specific obj

update

public void update(ApiType object)

Description copied from interface: Store

Sets an item in the store to its updated state.

Specified by:

update in interface Store<ApiType extends KubernetesObject>

Parameters:

object - specific obj

delete

public void delete(ApiType object)

Description copied from interface: Store

Removes an item from the store.

Specified by:

delete in interface Store<ApiType extends KubernetesObject>

Parameters:

object - specific obj

replace

public void replace(List<ApiType> objects)

Description copied from interface: Store

Replace the content in the cache completely.

Specified by:

replace in interface Store<ApiType extends KubernetesObject>

Parameters:

objects - list of kubernetes objects

listKeys

public List<String> listKeys()

Description copied from interface: Store

Returns a list of keys of all objects that are currently in the store.

Specified by:

listKeys in interface Store<ApiType extends KubernetesObject>

Returns:

list of all keys

list

public List<ApiType> list()

Description copied from interface: Store

Returns a list of all the items.

Specified by:

list in interface Store<ApiType extends KubernetesObject>

Returns:

list of all the items

getByKey

public ApiType getByKey(String key)

Description copied from interface: Store

Returns the request item with specific key.

Specified by:

getByKey in interface Store<ApiType extends KubernetesObject>

Parameters:

key - specific key

Returns:

the request item

indexKeys

public List<String> indexKeys(String indexName,
 String indexKey)

Description copied from interface: Indexer

Returns a list of object keys by index name and index key.

Specified by:

indexKeys in interface Indexer<ApiType extends KubernetesObject>

Parameters:

indexName - the index name

indexKey - the index key

Returns:

the list of kubernetes object keys

byIndex

public List<ApiType> byIndex(String indexName,
 String indexKey)

Description copied from interface: Indexer

Returns a list of objects by index name and index key.

Specified by:

byIndex in interface Indexer<ApiType extends KubernetesObject>

Parameters:

indexName - the index name

indexKey - the index key

Returns:

the list of kubernetes objects

getIndexers

public Map<String, Function<ApiType, List<String>>> getIndexers()

Description copied from interface: Indexer

Return the indexers registered with the store.

Specified by:

getIndexers in interface Indexer<ApiType extends KubernetesObject>

Returns:

registered indexers