IndicesQueryCache (elasticsearch-extend 3.2 API)

java.lang.Object
- org.elasticsearch.indices.IndicesQueryCache

All Implemented Interfaces:: Closeable, AutoCloseable, QueryCache

public class IndicesQueryCache
extends Object
implements QueryCache, Closeable

Field Summary

Fields
Modifier and Type	Field	Description
`static Setting<Integer>`	`INDICES_CACHE_QUERY_COUNT_SETTING`
`static Setting<ByteSizeValue>`	`INDICES_CACHE_QUERY_SIZE_SETTING`
`static Setting<Boolean>`	`INDICES_QUERIES_CACHE_ALL_SEGMENTS_SETTING`

Constructor Summary

Constructors
Constructor Description

IndicesQueryCache(Settings settings)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`clearIndex(String index)`	Clear all entries that belong to the given index.
`void`	`close()`
`Weight`	`doCache(Weight weight, QueryCachingPolicy policy)`	Return a wrapper around the provided `weight` that will cache matching docs per-segment accordingly to the given `policy`.
`QueryCacheStats`	`getStats(ShardId shard)`	Get usage statistics for the given shard.
`void`	`onClose(ShardId shardId)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - INDICES_CACHE_QUERY_SIZE_SETTING
```
public static final Setting<ByteSizeValue> INDICES_CACHE_QUERY_SIZE_SETTING
```
  - INDICES_CACHE_QUERY_COUNT_SETTING
```
public static final Setting<Integer> INDICES_CACHE_QUERY_COUNT_SETTING
```
  - INDICES_QUERIES_CACHE_ALL_SEGMENTS_SETTING
```
public static final Setting<Boolean> INDICES_QUERIES_CACHE_ALL_SEGMENTS_SETTING
```
- Constructor Detail
  - IndicesQueryCache
```
public IndicesQueryCache(Settings settings)
```
- Method Detail
  - getStats
```
public QueryCacheStats getStats(ShardId shard)
```
    Get usage statistics for the given shard.
  - doCache
```
public Weight doCache(Weight weight,
                      QueryCachingPolicy policy)
```
    Description copied from interface: QueryCache
    
    Return a wrapper around the provided weight that will cache matching docs per-segment accordingly to the given policy. NOTE: The returned weight will only be equivalent if scores are not needed.
    
    Specified by:
    
    doCache in interface QueryCache
    
    See Also:
    
    Collector.scoreMode()
  - clearIndex
```
public void clearIndex(String index)
```
    Clear all entries that belong to the given index.
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - onClose
```
public void onClose(ShardId shardId)
```