GridCacheAttributes (gridgain-core 6.1.9 API)

java.lang.Object
- org.gridgain.grid.kernal.processors.cache.GridCacheAttributes

All Implemented Interfaces:

Externalizable, Serializable
```
public class GridCacheAttributes
extends Object
implements Externalizable
```
Cache attributes.
This class contains information on a single cache configured on some node.

See Also:
Serialized Form

Field Summary

Fields
Modifier and Type Field and Description

protected boolean swapEnabled
Flag indicating whether GridGain should use swap storage by default.

Fields
Modifier and Type	Field and Description
`protected boolean`	`swapEnabled` Flag indicating whether GridGain should use swap storage by default.

Constructor Summary

Constructors
Constructor and Description

GridCacheAttributes()
Public no-arg constructor for Externalizable.

GridCacheAttributes(GridCacheConfiguration cfg)

Constructors
Constructor and Description
`GridCacheAttributes()` Public no-arg constructor for `Externalizable`.
`GridCacheAttributes(GridCacheConfiguration cfg)`

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`affinityHashIdResolverClassName()`
`boolean`	`affinityIncludeNeighbors()`
`int`	`affinityKeyBackups()`
`int`	`affinityPartitionsCount()`
`String`	`affinityReplicaCountAttrName()`
`int`	`affinityReplicas()`
`GridCacheAtomicityMode`	`atomicityMode()`
`String`	`cacheAffinityClassName()`
`String`	`cacheAffinityMapperClassName()`
`GridCacheMode`	`cacheMode()`
`String`	`cacheName()`
`GridCachePreloadMode`	`cachePreloadMode()`
`String`	`clonerClassName()`
`GridCacheTxConcurrency`	`defaultConcurrency()`
`GridCacheTxIsolation`	`defaultIsolation()`
`long`	`defaultLockTimeout()`
`long`	`defaultQueryTimeout()`
`long`	`defaultTimeToLive()`
`long`	`defaultTxTimeout()`
`long`	`dgcFrequency()`
`boolean`	`dgcRemoveLocks()`
`long`	`dgcSuspectLockTimeout()`
`GridCacheDrReceiveAttributes`	`drReceiveAttributes()`
`GridCacheDrSendAttributes`	`drSendAttributes()`
`String`	`evictionFilterClassName()`
`String`	`evictionPolicyClassName()`
`float`	`evictMaxOverflowRatio()`
`boolean`	`evictNearSynchronized()`
`boolean`	`evictSynchronized()`
`String`	`indexingSpiName()`
`boolean`	`isAffinityNode()`
`boolean`	`nearCacheEnabled()`
`String`	`nearEvictionPolicyClassName()`
`GridCacheDistributionMode`	`partitionedTaxonomy()`
`int`	`preloadBatchSize()`
`boolean`	`queryIndexEnabled()`
`void`	`readExternal(ObjectInput in)`
`int`	`sequenceReserveSize()`
`String`	`storeClassName()`
`boolean`	`storeEnabled()`
`boolean`	`storeValueBytes()`
`boolean`	`swapEnabled()`
`String`	`toString()`
`String`	`transactionManagerLookupClassName()`
`boolean`	`txBatchUpdate()`
`boolean`	`txSerializableEnabled()`
`int`	`writeBehindBatchSize()`
`boolean`	`writeBehindEnabled()`
`long`	`writeBehindFlushFrequency()`
`int`	`writeBehindFlushSize()`
`int`	`writeBehindFlushThreadCount()`
`void`	`writeExternal(ObjectOutput out)`
`GridCacheWriteSynchronizationMode`	`writeSynchronization()`

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

- Field Detail
  - swapEnabled
```
protected boolean swapEnabled
```
    Flag indicating whether GridGain should use swap storage by default.
- Constructor Detail
  - GridCacheAttributes
```
public GridCacheAttributes(GridCacheConfiguration cfg)
```
    Parameters:
    cfg - Cache configuration.
  - GridCacheAttributes
```
public GridCacheAttributes()
```
    Public no-arg constructor for Externalizable.
- Method Detail
  - cacheName
```
public String cacheName()
```
    Returns:
    Cache name.
  - cacheMode
```
public GridCacheMode cacheMode()
```
    Returns:
    Cache mode.
  - atomicityMode
```
public GridCacheAtomicityMode atomicityMode()
```
    Returns:
    Cache atomicity mode.
  - nearCacheEnabled
```
public boolean nearCacheEnabled()
```
    Returns:
    True if near cache is enabled.
  - isAffinityNode
```
public boolean isAffinityNode()
```
    Returns:
    True if the local node will not contribute any local storage to this cache, false otherwise.
  - cachePreloadMode
```
public GridCachePreloadMode cachePreloadMode()
```
    Returns:
    Preload mode.
  - cacheAffinityClassName
```
public String cacheAffinityClassName()
```
    Returns:
    Affinity class name.
  - cacheAffinityMapperClassName
```
public String cacheAffinityMapperClassName()
```
    Returns:
    Affinity mapper class name.
  - affinityIncludeNeighbors
```
public boolean affinityIncludeNeighbors()
```
    Returns:
    Affinity include neighbors.
  - affinityKeyBackups
```
public int affinityKeyBackups()
```
    Returns:
    Affinity key backups.
  - affinityReplicas
```
public int affinityReplicas()
```
    Returns:
    Affinity replicas.
  - affinityPartitionsCount
```
public int affinityPartitionsCount()
```
    Returns:
    Affinity partitions count.
  - affinityReplicaCountAttrName
```
public String affinityReplicaCountAttrName()
```
    Returns:
    Aff replicas count attr name.
  - affinityHashIdResolverClassName
```
public String affinityHashIdResolverClassName()
```
    Returns:
    Affinity hash ID resolver class name.
  - clonerClassName
```
public String clonerClassName()
```
    Returns:
    Cloner class name.
  - evictionFilterClassName
```
public String evictionFilterClassName()
```
    Returns:
    Eviction filter class name.
  - evictionPolicyClassName
```
public String evictionPolicyClassName()
```
    Returns:
    Eviction policy class name.
  - nearEvictionPolicyClassName
```
public String nearEvictionPolicyClassName()
```
    Returns:
    Near eviction policy class name.
  - storeClassName
```
public String storeClassName()
```
    Returns:
    Store class name.
  - transactionManagerLookupClassName
```
public String transactionManagerLookupClassName()
```
    Returns:
    Transaction manager lookup class name.
  - swapEnabled
```
public boolean swapEnabled()
```
    Returns:
    True if swap enabled.
  - defaultTimeToLive
```
public long defaultTimeToLive()
```
    Returns:
    Default time to live for cache entries.
  - evictSynchronized
```
public boolean evictSynchronized()
```
    Returns:
    Flag indicating whether eviction is synchronized.
  - evictNearSynchronized
```
public boolean evictNearSynchronized()
```
    Returns:
    Flag indicating whether eviction is synchronized with near nodes.
  - evictMaxOverflowRatio
```
public float evictMaxOverflowRatio()
```
    Returns:
    Maximum eviction overflow ratio.
  - defaultIsolation
```
public GridCacheTxIsolation defaultIsolation()
```
    Returns:
    Transaction isolation.
  - defaultConcurrency
```
public GridCacheTxConcurrency defaultConcurrency()
```
    Returns:
    Transaction concurrency.
  - partitionedTaxonomy
```
public GridCacheDistributionMode partitionedTaxonomy()
```
    Returns:
    Partitioned cache mode.
  - txSerializableEnabled
```
public boolean txSerializableEnabled()
```
    Returns:
    Default transaction serializable flag.
  - txBatchUpdate
```
public boolean txBatchUpdate()
```
    Returns:
    Flag to enable transactional batch update.
  - defaultTxTimeout
```
public long defaultTxTimeout()
```
    Returns:
    Default transaction timeout.
  - defaultQueryTimeout
```
public long defaultQueryTimeout()
```
    Returns:
    Default query timeout.
  - defaultLockTimeout
```
public long defaultLockTimeout()
```
    Returns:
    Default lock timeout.
  - storeValueBytes
```
public boolean storeValueBytes()
```
    Returns:
    Flag indicating if cached values should be additionally stored in serialized form.
  - preloadBatchSize
```
public int preloadBatchSize()
```
    Returns:
    Preload batch size.
  - dgcFrequency
```
public long dgcFrequency()
```
    Returns:
    Distributed garbage collection frequency.
  - dgcSuspectLockTimeout
```
public long dgcSuspectLockTimeout()
```
    Returns:
    Timeout after which DGC will consider remote locks as suspects.
  - dgcRemoveLocks
```
public boolean dgcRemoveLocks()
```
    Returns:
    Flag indicating whether DGC should remove locks.
  - writeSynchronization
```
public GridCacheWriteSynchronizationMode writeSynchronization()
```
    Returns:
    Synchronization mode.
  - queryIndexEnabled
```
public boolean queryIndexEnabled()
```
    Returns:
    Flag indicating whether query indexing is enabled.
  - storeEnabled
```
public boolean storeEnabled()
```
    Returns:
    Flag indicating whether GridGain should activate read-through/write-through behaviour by default.
  - writeBehindEnabled
```
public boolean writeBehindEnabled()
```
    Returns:
    Flag indicating whether GridGain should use write-behind behaviour for the cache store.
  - writeBehindFlushSize
```
public int writeBehindFlushSize()
```
    Returns:
    Maximum size of write-behind cache.
  - writeBehindFlushFrequency
```
public long writeBehindFlushFrequency()
```
    Returns:
    Write-behind flush frequency in milliseconds.
  - writeBehindFlushThreadCount
```
public int writeBehindFlushThreadCount()
```
    Returns:
    Flush thread count for write-behind cache store.
  - writeBehindBatchSize
```
public int writeBehindBatchSize()
```
    Returns:
    Maximum batch size for write-behind cache store.
  - sequenceReserveSize
```
public int sequenceReserveSize()
```
    Returns:
    Default batch size for all cache's sequences.
  - indexingSpiName
```
public String indexingSpiName()
```
    Returns:
    Name of SPI to use for indexing.
  - drReceiveAttributes
```
@Nullable
public GridCacheDrReceiveAttributes drReceiveAttributes()
```
    Returns:
    DR receive attributes.
  - drSendAttributes
```
@Nullable
public GridCacheDrSendAttributes drSendAttributes()
```
    Returns:
    DR send attributes.
  - writeExternal
```
public void writeExternal(ObjectOutput out)
                   throws IOException
```
    Specified by:
    
    writeExternal in interface Externalizable
    
    Throws:
    
    IOException
  - readExternal
```
public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException
```
    Specified by:
    
    readExternal in interface Externalizable
    
    Throws:
    
    IOException
    
    ClassNotFoundException
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class GridCacheAttributes

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

swapEnabled

Constructor Detail

GridCacheAttributes

GridCacheAttributes

Method Detail

cacheName

cacheMode

atomicityMode

nearCacheEnabled

isAffinityNode

cachePreloadMode

cacheAffinityClassName

cacheAffinityMapperClassName

affinityIncludeNeighbors

affinityKeyBackups

affinityReplicas

affinityPartitionsCount

affinityReplicaCountAttrName

affinityHashIdResolverClassName

clonerClassName

evictionFilterClassName

evictionPolicyClassName

nearEvictionPolicyClassName

storeClassName

transactionManagerLookupClassName

swapEnabled

defaultTimeToLive

evictSynchronized

evictNearSynchronized

evictMaxOverflowRatio

defaultIsolation

defaultConcurrency

partitionedTaxonomy

txSerializableEnabled

txBatchUpdate

defaultTxTimeout

defaultQueryTimeout

defaultLockTimeout

storeValueBytes

preloadBatchSize

dgcFrequency

dgcSuspectLockTimeout

dgcRemoveLocks

writeSynchronization

queryIndexEnabled

storeEnabled

writeBehindEnabled

writeBehindFlushSize

writeBehindFlushFrequency

writeBehindFlushThreadCount

writeBehindBatchSize

sequenceReserveSize

indexingSpiName

drReceiveAttributes

drSendAttributes

writeExternal

readExternal

toString