Package org.opensearch.indices.fielddata.cache

Class IndicesFieldDataCache

java.lang.Object

org.opensearch.indices.fielddata.cache.IndicesFieldDataCache

All Implemented Interfaces:

Closeable, AutoCloseable, RemovalListener<IndicesFieldDataCache.Key,org.apache.lucene.util.Accountable>, org.opensearch.common.lease.Releasable

@PublicApi(since="1.0.0")
public class IndicesFieldDataCache
extends Object
implements RemovalListener<IndicesFieldDataCache.Key,org.apache.lucene.util.Accountable>, org.opensearch.common.lease.Releasable

The field data cache for multiple indices

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IndicesFieldDataCache.FieldDataWeigher	Computes a weight based on ramBytesUsed
static class	IndicesFieldDataCache.Key	Key for the indices field data cache

Field Summary

Fields

Modifier and Type	Field	Description
static final Setting<org.opensearch.core.common.unit.ByteSizeValue>	INDICES_FIELDDATA_CACHE_SIZE_KEY

Constructor Summary

Constructors

Constructor	Description
IndicesFieldDataCache(Settings settings, IndexFieldDataCache.Listener indicesFieldDataCacheListener)

Method Summary

Modifier and Type	Method	Description
IndexFieldDataCache	buildIndexFieldDataCache(IndexFieldDataCache.Listener listener, org.opensearch.core.index.Index index, String fieldName)
void	close()
Cache<IndicesFieldDataCache.Key,org.apache.lucene.util.Accountable>	getCache()
void	onRemoval(RemovalNotification<IndicesFieldDataCache.Key,org.apache.lucene.util.Accountable> notification)

Methods inherited from class java.lang.Object

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

Field Details

INDICES_FIELDDATA_CACHE_SIZE_KEY

public static final Setting<org.opensearch.core.common.unit.ByteSizeValue> INDICES_FIELDDATA_CACHE_SIZE_KEY

Constructor Details

IndicesFieldDataCache

public IndicesFieldDataCache(Settings settings,
 IndexFieldDataCache.Listener indicesFieldDataCacheListener)

Method Details

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface org.opensearch.common.lease.Releasable

buildIndexFieldDataCache

public IndexFieldDataCache buildIndexFieldDataCache(IndexFieldDataCache.Listener listener,
 org.opensearch.core.index.Index index,
 String fieldName)

getCache

public Cache<IndicesFieldDataCache.Key,org.apache.lucene.util.Accountable> getCache()

onRemoval

public void onRemoval(RemovalNotification<IndicesFieldDataCache.Key,org.apache.lucene.util.Accountable> notification)

Specified by:

onRemoval in interface RemovalListener<IndicesFieldDataCache.Key,org.apache.lucene.util.Accountable>