RegionPrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.RegionPrms

```
public class RegionPrms
extends BasePrms
```
A class used to store keys for region configuration settings. The settings are used to create instances of RegionDescription.
The number of description instances is gated by names. For other parameters, if fewer values than names are given, the remaining instances will use the last value in the list. See $JTESTS/hydra/hydra.txt for more details.
Unused parameters default to null, except where noted. This uses the product default, except where noted.
Values, fields, and subfields of a parameter can be set to BasePrms.DEFAULT, except where noted. This uses the product default, except where noted.
Values, fields, and subfields can be set to BasePrms.NONE where noted, with the documented effect.
Values, fields, and subfields of a parameter can use oneof, range, or robing except where noted, but each description created will use a fixed value chosen at test configuration time. Use as a task attribute is illegal.
Subfields are order-dependent, as stated in the javadocs for parameters that use them.

Field Summary

Fields
Modifier and Type	Field and Description
`static Long`	`asyncEventQueueNames` (Comma-separated lists of String(s)) Names of logical async event queue configurations (and actual ids) for each region, as found in `AsyncEventQueuePrms.names`.
`static Long`	`cacheListeners` (Comma-separated String(s)) Class names of cache listeners for each region.
`static Long`	`cacheListenersSingleton` (boolean(s)) Whether the `cacheListeners` for each region are singletons across all actual regions created with this description.
`static Long`	`cacheLoader` (String(s)) Cache loader for each region, consisting of an application classname.
`static Long`	`cacheLoaderSingleton` (boolean(s)) Whether the `cacheLoader` for each region is a singleton across all actual regions created with this description.
`static Long`	`cacheWriter` (String(s)) Cache writer for each region, consisting of an application classname.
`static Long`	`cacheWriterSingleton` (boolean(s)) Whether the `cacheWriter` for each region is a singleton across all actual regions created with this description.
`static Long`	`cloningEnabled` (boolean(s)) Cloning enabled for delta propagation on each region.
`static Long`	`compressor` (String(s)) Compressor for each region, consisting of an application classname.
`static Long`	`compressorSingleton` (boolean(s)) Whether the `compressor` for each region is a singleton across all actual regions created with this description.
`static Long`	`concurrencyChecksEnabled` (boolean(s)) concurrencyChecksEnabled for each region.
`static Long`	`concurrencyLevel` (int(s)) Concurrency level for each region.
`static Long`	`customEntryIdleTimeout` (String(s)) Classname of the custom entry idle timeout for each region.
`static Long`	`customEntryTimeToLive` (String(s)) Classname of the custom entry time to live for each region.
`static Long`	`dataPolicy` (String(s)) Data policy for each region.
`static String`	`DEFAULT_REGION_NAME`
`static Long`	`diskStoreName` (String(s)) Name of logical disk store configuration (and actual disk store name) for each region, as found in `DiskStorePrms.names`.
`static Long`	`diskSynchronous` (Boolean(s)) Disk synchronous for each region.
`static Long`	`enableAsyncConflation` (boolean(s)) Enable async conflation for each region.
`static Long`	`enableGateway` (boolean(s)) Enable gateway for each region.
`static Long`	`enableOffHeapMemory` (boolean(s)) Enable off-heap memory for each region.
`static Long`	`enableSubscriptionConflation` (boolean(s)) Enable subscription conflation for each region.
`static Long`	`entryIdleTimeout` (Comma-separated int/String pair(s)) Entry idle timeout consisting for each region of the timeout in seconds followed by an optional expiration action.
`static Long`	`entryTimeToLive` (Comma-separated int/String pair(s)) Entry time to live consisting for each region of the time in seconds followed by an optional expiration action.
`static Long`	`evictionAttributes` (Comma-separated tuple(s)) Eviction attributes consisting for each region of the algorithm followed by an ordered set of optional fields that depend on the algorithm.
`static Long`	`gatewaySenderNames` (Comma-separated lists of String(s)) Names of logical gateway sender configurations for each region, as found in `GatewaySenderPrms.names`.
`static Long`	`hdfsStoreName` (String(s)) HDFS store name for each region.
`static Long`	`hdfsWriteOnly` (boolean(s)) HDFS write-only for each region.
`static Long`	`ignoreJTA` (boolean(s)) Ignore JTA for each region.
`static Long`	`indexMaintenanceSynchronous` (boolean(s)) Index maintenance synchronous for each region.
`static Long`	`initialCapacity` (int(s)) Initial capacity for each region.
`static Long`	`interestPolicy` (String(s)) Interest policy for each region.
`static Long`	`keyConstraint` (String(s)) Class name of key constraint for each region.
`static Long`	`loadFactor` (float(s)) Load factor for each region.
`static Long`	`lockGrantor` (boolean(s)) Lock grantor for each region.
`static Long`	`membershipAttributes` (Comma-separated String/String/String triplet(s)) Membership attributes consisting for each region of required roles, followed by an optional loss action and an optional resumption action.
`static Long`	`multicastEnabled` (boolean(s)) Multicast enabled for each region.
`static Long`	`names` (String(s)) Logical names of the region descriptions.
`static Long`	`partitionName` (String(s)) Name of logical partition configuration for each region, as found in `PartitionPrms.names`.
`static Long`	`poolName` (String(s)) Name of logical pool configuration (and actual pool name) for each region, as found in `PoolPrms.names`.
`static Long`	`regionIdleTimeout` (Comma-separated int/String pair(s)) Region idle timeout consisting for each region of the timeout in seconds followed by an optional expiration action.
`static Long`	`regionName` (String(s)) Actual name for each region.
`static Long`	`regionTimeToLive` (Comma-separated int/String pair(s)) Region time to live consisting for each region of the time in seconds followed by an optional expiration action.
`static Long`	`scope` (String(s)) Scope for each region.
`static Long`	`statisticsEnabled` (boolean(s)) Statistics enabled for each region.
`static Long`	`valueConstraint` (String(s)) Class name of value constraint for each region.

Fields inherited from class hydra.BasePrms
DASH, DEFAULT, NONE

Constructor Summary

Constructors
Constructor and Description

RegionPrms()

Constructors
Constructor and Description
`RegionPrms()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type Method and Description

static void main(String[] args)
- Methods inherited from class hydra.BasePrms
  dumpKeys, keyForName, nameForKey, setValues, tab, tasktab
- Methods inherited from class java.lang.Object
  clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`main(String[] args)`

- Field Detail
  - DEFAULT_REGION_NAME
```
public static final String DEFAULT_REGION_NAME
```
    See Also:
    
    Constant Field Values
  - names
```
public static Long names
```
    (String(s)) Logical names of the region descriptions. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.
  - asyncEventQueueNames
```
public static Long asyncEventQueueNames
```
    (Comma-separated lists of String(s)) Names of logical async event queue configurations (and actual ids) for each region, as found in AsyncEventQueuePrms.names. Can be specified as BasePrms.NONE (default).
    
    See Also:
    
    AsyncEventQueuePrms
  - cacheListeners
```
public static Long cacheListeners
```
    (Comma-separated String(s)) Class names of cache listeners for each region. Can be specified as BasePrms.NONE. See cacheListenersSingleton for control over instance creation.
    Example: To use ClassA and ClassB for the first region, no listeners for the second region, and ClassC for the third region, specify: ClassA ClassB, none, ClassC
  - cacheListenersSingleton
```
public static Long cacheListenersSingleton
```
    (boolean(s)) Whether the cacheListeners for each region are singletons across all actual regions created with this description. Defaults to false.
  - cacheLoader
```
public static Long cacheLoader
```
    (String(s)) Cache loader for each region, consisting of an application classname. Can be specified as BasePrms.NONE (default). See cacheLoaderSingleton for control over instance creation.
    Example: To use an application cache loader in the first region, no loader in the second, and another loader in the third, the value might look like: mypackage.MyRdbLoader, none, myotherpackage.MyOtherLoader
  - cacheLoaderSingleton
```
public static Long cacheLoaderSingleton
```
    (boolean(s)) Whether the cacheLoader for each region is a singleton across all actual regions created with this description. Defaults to false.
  - cacheWriter
```
public static Long cacheWriter
```
    (String(s)) Cache writer for each region, consisting of an application classname. Can be specified as BasePrms.NONE (default). See cacheWriterSingleton for control over instance creation.
    Example: To use an application cache writer in the first region, no writer in the second, and another writer in the third, the value might look like: mypackage.MyRdbWriter, none, myotherpackage.MyOtherWriter
  - cacheWriterSingleton
```
public static Long cacheWriterSingleton
```
    (boolean(s)) Whether the cacheWriter for each region is a singleton across all actual regions created with this description. Defaults to false.
  - cloningEnabled
```
public static Long cloningEnabled
```
    (boolean(s)) Cloning enabled for delta propagation on each region.
  - compressor
```
public static Long compressor
```
    (String(s)) Compressor for each region, consisting of an application classname. Can be specified as BasePrms.NONE (default). See compressorSingleton for control over instance creation.
    Example: To use an application compressor in the first region, none in the second, and another in the third, the value might look like: mypackage.MyCompressor, none, myotherpackage.MyOtherCompressor
  - compressorSingleton
```
public static Long compressorSingleton
```
    (boolean(s)) Whether the compressor for each region is a singleton across all actual regions created with this description. Defaults to false.
  - concurrencyChecksEnabled
```
public static Long concurrencyChecksEnabled
```
    (boolean(s)) concurrencyChecksEnabled for each region.
  - concurrencyLevel
```
public static Long concurrencyLevel
```
    (int(s)) Concurrency level for each region.
  - customEntryIdleTimeout
```
public static Long customEntryIdleTimeout
```
    (String(s)) Classname of the custom entry idle timeout for each region. Must implement CustomExpiry. Can be specified as BasePrms.NONE (default).
  - customEntryTimeToLive
```
public static Long customEntryTimeToLive
```
    (String(s)) Classname of the custom entry time to live for each region. Must implement CustomExpiry. Can be specified as BasePrms.NONE (default).
  - dataPolicy
```
public static Long dataPolicy
```
    (String(s)) Data policy for each region. If the data policy partitions the region, then partitionName must also be set. If the data policy causes persistence, diskStoreName must also be set.
  - diskStoreName
```
public static Long diskStoreName
```
    (String(s)) Name of logical disk store configuration (and actual disk store name) for each region, as found in DiskStorePrms.names. Required when using persistence. Can be specified as BasePrms.NONE (default).
  - diskSynchronous
```
public static Long diskSynchronous
```
    (Boolean(s)) Disk synchronous for each region. Meaningful only when diskStoreName is set.
  - enableAsyncConflation
```
public static Long enableAsyncConflation
```
    (boolean(s)) Enable async conflation for each region.
  - enableGateway
```
public static Long enableGateway
```
    (boolean(s)) Enable gateway for each region.
  - enableOffHeapMemory
```
public static Long enableOffHeapMemory
```
    (boolean(s)) Enable off-heap memory for each region.
  - enableSubscriptionConflation
```
public static Long enableSubscriptionConflation
```
    (boolean(s)) Enable subscription conflation for each region.
  - entryIdleTimeout
```
public static Long entryIdleTimeout
```
    (Comma-separated int/String pair(s)) Entry idle timeout consisting for each region of the timeout in seconds followed by an optional expiration action. The timeout can be specified as BasePrms.NONE (no expiration).
    Example: To use 30 seconds with destroy in the first region, the defaults in the second region, 60 seconds with invalidate in the third region, and no expiration in the fourth region, specify: 30 destroy, default, 60 invalidate, none
  - entryTimeToLive
```
public static Long entryTimeToLive
```
    (Comma-separated int/String pair(s)) Entry time to live consisting for each region of the time in seconds followed by an optional expiration action. The time can be specified as BasePrms.NONE (no expiration).
    See entryIdleTimeout for an example.
  - evictionAttributes
```
public static Long evictionAttributes
```
    (Comma-separated tuple(s)) Eviction attributes consisting for each region of the algorithm followed by an ordered set of optional fields that depend on the algorithm. The algorithm can be specified as BasePrms.NONE (no eviction), as can the object sizer.
    If the eviction algorithm is "lruHeapPercentage", also set ResourceManagerPrms.evictionHeapPercentage as needed.
    If the eviction action requires overflow to disk, diskStoreName must also be set.
    Valid algorithms and optional fields:
    "none"
    "lruEntryCount" maximumEntries(int) evictionAction(String)
    "lruHeapPercentage" objectSizer(String), must be Serializable evictionAction(String)
    "lruMemorySize" maximumMegabytes(int) objectSizer(String), must be Serializable evictionAction(String)
    Example: To use entry count eviction on the first region, heap eviction on the second, memory size eviction on the third, and no eviction on the fourth, the value might look something like this: lruEntryCount default overflowToDisk, lruHeapPercentage default overflowToDisk, lruMemorySize default mytests.MyClass, none
  - gatewaySenderNames
```
public static Long gatewaySenderNames
```
    (Comma-separated lists of String(s)) Names of logical gateway sender configurations for each region, as found in GatewaySenderPrms.names. Can be specified as BasePrms.NONE (default).
    
    See Also:
    
    GatewaySenderPrms
  - hdfsStoreName
```
public static Long hdfsStoreName
```
    (String(s)) HDFS store name for each region.
  - hdfsWriteOnly
```
public static Long hdfsWriteOnly
```
    (boolean(s)) HDFS write-only for each region.
  - ignoreJTA
```
public static Long ignoreJTA
```
    (boolean(s)) Ignore JTA for each region.
  - indexMaintenanceSynchronous
```
public static Long indexMaintenanceSynchronous
```
    (boolean(s)) Index maintenance synchronous for each region.
  - initialCapacity
```
public static Long initialCapacity
```
    (int(s)) Initial capacity for each region.
  - interestPolicy
```
public static Long interestPolicy
```
    (String(s)) Interest policy for each region. This is transparently converted to subscription attributes.
  - keyConstraint
```
public static Long keyConstraint
```
    (String(s)) Class name of key constraint for each region. Can be specified as BasePrms.NONE.
  - loadFactor
```
public static Long loadFactor
```
    (float(s)) Load factor for each region.
  - lockGrantor
```
public static Long lockGrantor
```
    (boolean(s)) Lock grantor for each region.
  - membershipAttributes
```
public static Long membershipAttributes
```
    (Comma-separated String/String/String triplet(s)) Membership attributes consisting for each region of required roles, followed by an optional loss action and an optional resumption action. To specify multiple roles, use a colon (:) between them. The required roles and the resumption action can be specified as BasePrms.NONE.
    Example: To use roles "Buyer" and "Seller" on the first region, no roles on the second, and role "Taxer" on the third, the value might look something like this: Buyer:Seller default reinitialize, none, Taxer reconnect
  - multicastEnabled
```
public static Long multicastEnabled
```
    (boolean(s)) Multicast enabled for each region. The default is to inherit the multicast setting for the distributed system in which the region is created, as set in GemFirePrms.enableMcast.
  - partitionName
```
public static Long partitionName
```
    (String(s)) Name of logical partition configuration for each region, as found in PartitionPrms.names. Can be specified as BasePrms.NONE (default). If the dataPolicy partitions the region, this must be set to a non-default value.
  - poolName
```
public static Long poolName
```
    (String(s)) Name of logical pool configuration (and actual pool name) for each region, as found in PoolPrms.names. Can be specified as BasePrms.NONE (default).
  - regionIdleTimeout
```
public static Long regionIdleTimeout
```
    (Comma-separated int/String pair(s)) Region idle timeout consisting for each region of the timeout in seconds followed by an optional expiration action. The timeout can be specified as BasePrms.NONE (no expiration).
    See entryIdleTimeout for an example.
  - regionName
```
public static Long regionName
```
    (String(s)) Actual name for each region. Defaults to DEFAULT_REGION_NAME.
  - regionTimeToLive
```
public static Long regionTimeToLive
```
    (Comma-separated int/String pair(s)) Region time to live consisting for each region of the time in seconds followed by an optional expiration action. The time can be specified as BasePrms.NONE (no expiration).
    See entryIdleTimeout for an example.
  - scope
```
public static Long scope
```
    (String(s)) Scope for each region.
  - statisticsEnabled
```
public static Long statisticsEnabled
```
    (boolean(s)) Statistics enabled for each region.
  - valueConstraint
```
public static Long valueConstraint
```
    (String(s)) Class name of value constraint for each region. Can be specified as BasePrms.NONE.
- Constructor Detail
  - RegionPrms
```
public RegionPrms()
```
- Method Detail
  - main
```
public static void main(String[] args)
```

Class RegionPrms

Field Summary

Fields inherited from class hydra.BasePrms

Constructor Summary

Method Summary

Methods inherited from class hydra.BasePrms

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_REGION_NAME

names

asyncEventQueueNames

cacheListeners

cacheListenersSingleton

cacheLoader

cacheLoaderSingleton

cacheWriter

cacheWriterSingleton

cloningEnabled

compressor

compressorSingleton

concurrencyChecksEnabled

concurrencyLevel

customEntryIdleTimeout

customEntryTimeToLive

dataPolicy

diskStoreName

diskSynchronous

enableAsyncConflation

enableGateway

enableOffHeapMemory

enableSubscriptionConflation

entryIdleTimeout

entryTimeToLive

evictionAttributes

gatewaySenderNames

hdfsStoreName

hdfsWriteOnly

ignoreJTA

indexMaintenanceSynchronous

initialCapacity

interestPolicy

keyConstraint

loadFactor

lockGrantor

membershipAttributes

multicastEnabled

partitionName

poolName

regionIdleTimeout

regionName

regionTimeToLive

scope

statisticsEnabled

valueConstraint

Constructor Detail

RegionPrms

Method Detail

main