Apache Geode Native .NET Reference 1.15.0
Apache::Geode::Client::RegionAttributes< TKey, TValue > Class Template Reference

Defines attributes for configuring a region. More...

#include <RegionAttributes.hpp>

Inherits Apache::Geode::Client::IDataSerializableInternal.

Public Member Functions

virtual bool Equals (Object^ other) override
 True if all the attributes are equal to those of other. More...
 
bool Equals (RegionAttributes< TKey, TValue >^ other)
 True if all the attributes are equal to those of other. More...
 
virtual void FromData (DataInput^ input)
 Deserializes this Properties object. More...
 
virtual void ToData (DataOutput^ output)
 Serializes this Properties object. More...
 
String ^ ToString ()
 Return a string representation of the object. More...
 
void ValidateSerializableAttributes ()
 Throws IllegalStateException if the attributes are not suited for serialization such as those that have a cache callback (listener, loader, or writer) set directly instead of providing the library path and factory function. More...
 

Properties

ICacheListener< TKey, TValue >^ CacheListener [get]
 Gets the cache listener for the region. More...
 
String^ CacheListenerFactory [get]
 Returns the symbol name of the factory function from which the loader will be created on a cache server. More...
 
String^ CacheListenerLibrary [get]
 Returns the path of the library from which the factory function will be invoked on a cache server. More...
 
Apache::Geode::Client::ICacheLoader< TKey, TValue >^ CacheLoader [get]
 Gets the cache loader for the region. More...
 
String^ CacheLoaderFactory [get]
 Rreturns the symbol name of the factory function from which the loader will be created on a cache server. More...
 
String^ CacheLoaderLibrary [get]
 Returns the path of the library from which the factory function will be invoked on a cache server. More...
 
ICacheWriter< TKey, TValue >^ CacheWriter [get]
 Gets the cache writer for the region. More...
 
String^ CacheWriterFactory [get]
 Returns the symbol name of the factory function from which the loader will be created on a cache server. More...
 
String^ CacheWriterLibrary [get]
 Returns the path of the library from which the factory function will be invoked on a cache server. More...
 
bool CachingEnabled [get]
 If true, this region will store data in the current process. More...
 
bool ClientNotificationEnabled [get]
 True if client notification is enabled. More...
 
bool CloningEnabled [get]
 True if cloning is enabled for in case of delta. More...
 
bool ConcurrencyChecksEnabled [get]
 Returns the concurrency check enabled flag of the region More...
 
System::Int32 ConcurrencyLevel [get]
 Returns the concurrency level of the entry's local cache. More...
 
DiskPolicyType DiskPolicy [get]
 Returns the disk policy type of the region. More...
 
String^ Endpoints [get]
 This method returns the list of endpoints (servername:portnumber) separated by commas. More...
 
TimeSpan EntryIdleTimeout [get]
 Gets the idleTimeout value for entries in this region. More...
 
ExpirationAction EntryIdleTimeoutAction [get]
 Gets the idleTimeout expiration action for entries in this region. More...
 
TimeSpan EntryTimeToLive [get]
 Gets the timeToLive value for entries in this region. More...
 
ExpirationAction EntryTimeToLiveAction [get]
 Gets the timeToLive expiration action for entries in this region. More...
 
System::Int32 InitialCapacity [get]
 Returns the initial capacity of the entry's local cache. More...
 
Single LoadFactor [get]
 Returns the load factor of the entry's local cache. More...
 
System::UInt32 LruEntriesLimit [get]
 Returns the maximum number of entries this cache will hold before using LRU eviction. More...
 
ExpirationAction LruEvictionAction [get]
 Returns the ExpirationAction used for LRU Eviction, default is LOCAL_DESTROY. More...
 
virtual System::UInt64 ObjectSize [get]
 return the size of this object in bytes More...
 
IPartitionResolver< TKey, TValue >^ PartitionResolver [get]
 Gets the partition resolver for the region. More...
 
String^ PartitionResolverFactory [get]
 Returns the symbol name of the factory function from which the loader will be created on a cache server. More...
 
String^ PartitionResolverLibrary [get]
 Returns the path of the library from which the factory function will be invoked on a cache server. More...
 
String^ PersistenceFactory [get]
 Returns the symbol name of the factory function from which the persistence manager will be created on a cache server. More...
 
String^ PersistenceLibrary [get]
 Returns the path of the library from which the factory function will be invoked on a cache server. More...
 
Properties< String^, String^>^ PersistenceProperties [get]
 Returns the properties set for persistence. More...
 
String^ PoolName [get]
 This method returns the name of the attached pool. More...
 
TimeSpan RegionIdleTimeout [get]
 Gets the idleTimeout value for the region as a whole. More...
 
ExpirationAction RegionIdleTimeoutAction [get]
 Gets the idleTimeout expiration action for the region as a whole. More...
 
TimeSpan RegionTimeToLive [get]
 Gets the timeToLive value for the region as a whole. More...
 
ExpirationAction RegionTimeToLiveAction [get]
 Gets the timeToLive expiration action for the region as a whole. More...
 

Detailed Description

template<class TKey, class TValue>
class Apache::Geode::Client::RegionAttributes< TKey, TValue >

Defines attributes for configuring a region.

These are ICacheListener, ICacheLoader, ICacheWriter, scope, mirroring, and expiration attributes for the region itself; expiration attributes for the region entries; and whether statistics are enabled for the region and its entries.

To create an instance of this interface, use RegionAttributesFactory.Create.

For compatibility rules and default values, see RegionAttributesFactory.

Note that the RegionAttributes are not distributed with the region.

See also
RegionAttributesFactory, AttributesMutator, Region.Attributes

Member Function Documentation

◆ Equals() [1/2]

template<class TKey , class TValue >
virtual bool Apache::Geode::Client::RegionAttributes< TKey, TValue >::Equals ( Object^  other)
overridevirtual

True if all the attributes are equal to those of other.

Parameters
otherattribute object to compare
Returns
true if equal