ClientRegionPrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.ClientRegionPrms

```
public class ClientRegionPrms
extends BasePrms
```
A class used to store keys for region configuration settings. The settings are used to create instances of ClientRegionDescription.
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 java.lang.Long`	`cacheListeners` (Comma-separated String(s)) Class names of cache listeners for each region.
`static java.lang.Long`	`cacheListenersSingleton` (boolean(s)) Whether the `cacheListeners` for each region are singletons across all actual regions created with this description.
`static java.lang.Long`	`clientRegionShortcut` (String(s)) `ClientRegionShortcut` to use for each region.
`static java.lang.Long`	`cloningEnabled` (boolean(s)) Cloning enabled for delta propagation on each region.
`static java.lang.Long`	`concurrencyLevel` (int(s)) Concurrency level for each region.
`static java.lang.Long`	`customEntryIdleTimeout` (String(s)) Classname of the custom entry idle timeout for each region.
`static java.lang.Long`	`customEntryTimeToLive` (String(s)) Classname of the custom entry time to live for each region.
`static java.lang.String`	`DEFAULT_REGION_NAME`
`static java.lang.Long`	`diskStoreName` (String(s)) Name of logical disk store configuration (and actual disk store name) for each region, as found in `DiskStorePrms.names`.
`static java.lang.Long`	`diskSynchronous` (Boolean(s)) Disk synchronous for each region.
`static java.lang.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 java.lang.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 java.lang.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 java.lang.Long`	`initialCapacity` (int(s)) Initial capacity for each region.
`static java.lang.Long`	`keyConstraint` (String(s)) Class name of key constraint for each region.
`static java.lang.Long`	`loadFactor` (float(s)) Load factor for each region.
`static java.lang.Long`	`names` (String(s)) Logical names of the region descriptions.
`static java.lang.Long`	`poolName` (String(s)) Name of logical pool configuration (and actual pool name) for each region, as found in `PoolPrms.names`.
`static java.lang.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 java.lang.Long`	`regionName` (String(s)) Actual name for each region.
`static java.lang.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 java.lang.Long`	`statisticsEnabled` (boolean(s)) Statistics enabled for each region.
`static java.lang.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

ClientRegionPrms()

Constructors
Constructor and Description
`ClientRegionPrms()`

Method Summary

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

static void main(java.lang.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(java.lang.String[] args)`

- Field Detail
  - DEFAULT_REGION_NAME
```
public static final java.lang.String DEFAULT_REGION_NAME
```
    See Also:
    
    Constant Field Values
  - names
```
public static java.lang.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.
  - cacheListeners
```
public static java.lang.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 java.lang.Long cacheListenersSingleton
```
    (boolean(s)) Whether the cacheListeners for each region are singletons across all actual regions created with this description. Defaults to false.
  - clientRegionShortcut
```
public static java.lang.Long clientRegionShortcut
```
    (String(s)) ClientRegionShortcut to use for each region. This is a required parameter.
  - cloningEnabled
```
public static java.lang.Long cloningEnabled
```
    (boolean(s)) Cloning enabled for delta propagation on each region.
  - concurrencyLevel
```
public static java.lang.Long concurrencyLevel
```
    (int(s)) Concurrency level for each region.
  - customEntryIdleTimeout
```
public static java.lang.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 java.lang.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).
  - diskStoreName
```
public static java.lang.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 java.lang.Long diskSynchronous
```
    (Boolean(s)) Disk synchronous for each region. Meaningful only when diskStoreName is set.
  - entryIdleTimeout
```
public static java.lang.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 java.lang.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 java.lang.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
  - initialCapacity
```
public static java.lang.Long initialCapacity
```
    (int(s)) Initial capacity for each region.
  - keyConstraint
```
public static java.lang.Long keyConstraint
```
    (String(s)) Class name of key constraint for each region. Can be specified as BasePrms.NONE.
  - loadFactor
```
public static java.lang.Long loadFactor
```
    (float(s)) Load factor for each region.
  - poolName
```
public static java.lang.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 java.lang.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 java.lang.Long regionName
```
    (String(s)) Actual name for each region. Defaults to DEFAULT_REGION_NAME.
  - regionTimeToLive
```
public static java.lang.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.
  - statisticsEnabled
```
public static java.lang.Long statisticsEnabled
```
    (boolean(s)) Statistics enabled for each region.
  - valueConstraint
```
public static java.lang.Long valueConstraint
```
    (String(s)) Class name of value constraint for each region. Can be specified as BasePrms.NONE.
- Constructor Detail
  - ClientRegionPrms
```
public ClientRegionPrms()
```
- Method Detail
  - main
```
public static void main(java.lang.String[] args)
```

Class ClientRegionPrms

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

cacheListeners

cacheListenersSingleton

clientRegionShortcut

cloningEnabled

concurrencyLevel

customEntryIdleTimeout

customEntryTimeToLive

diskStoreName

diskSynchronous

entryIdleTimeout

entryTimeToLive

evictionAttributes

initialCapacity

keyConstraint

loadFactor

poolName

regionIdleTimeout

regionName

regionTimeToLive

statisticsEnabled

valueConstraint

Constructor Detail

ClientRegionPrms

Method Detail

main