DiskStorePrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - hydra.DiskStorePrms

```
public class DiskStorePrms
extends BasePrms
```
A class used to store keys for disk store configuration settings. The settings are used to create instances of DiskStoreDescription.
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`	`allowForceCompaction` (boolean(s)) Allow force compaction for each disk store.
`static Long`	`autoCompact` (boolean(s)) Auto compact for each disk store.
`static Long`	`compactionThreshold` (int(s)) Compaction threshold for each disk store.
`static Long`	`diskDirBaseMapFileName` (String(s)) Absolute name of a file containing a mapping of physical host names to lists of absolute base paths to use for each data store.
`static Long`	`diskDirBases` (Comma-separated String plus String(s) list) Absolute base paths for disk directories for each disk store, where each entry consists of a physical host name and list of base paths.
`static Long`	`diskDirNum` (int(s)) Number of disk directories to use for each data store.
`static Long`	`diskDirSizes` (Comma-separated int(s)) Sizes of disk directories to use for each data store, in megabytes.
`static Long`	`maxOplogSize` (long(s)) Max oplog size for each disk store, in megabytes.
`static Long`	`names` (String(s)) Logical names of the disk store descriptions and actual names of the disk stores.
`static Long`	`queueSize` (int(s)) Queue size for each disk store.
`static Long`	`timeInterval` (long(s)) Time interval for each disk store, in milliseconds.
`static Long`	`writeBufferSize` (int(s)) Write buffer size for each disk store, in bytes.

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

Constructor Summary

Constructors
Constructor and Description

DiskStorePrms()

Constructors
Constructor and Description
`DiskStorePrms()`

Method Summary
- 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

- Field Detail
  - names
```
public static Long names
```
    (String(s)) Logical names of the disk store descriptions and actual names of the disk stores. Each name must be unique. Defaults to null. Not for use with oneof, range, or robing.
  - allowForceCompaction
```
public static Long allowForceCompaction
```
    (boolean(s)) Allow force compaction for each disk store.
  - autoCompact
```
public static Long autoCompact
```
    (boolean(s)) Auto compact for each disk store.
  - compactionThreshold
```
public static Long compactionThreshold
```
    (int(s)) Compaction threshold for each disk store.
  - diskDirBases
```
public static Long diskDirBases
```
    (Comma-separated String plus String(s) list) Absolute base paths for disk directories for each disk store, where each entry consists of a physical host name and list of base paths. Defaults to null, which uses the same resource directory path configured in HostPrms.
    Example: hydra.DiskStorePrms-names = store1 store2; hydra.DiskStorePrms-diskDirNum = 3; hydra.DiskStorePrms-diskDirBases = // store1 wheat /export/wheat1/users/me/scratch /export/wheat2/users/me/scratch millet /export/millet1/users/me/scratch /export/millet2/users/me/scratch /export/millet3/users/me/scratch , // store2 default ; A region using store1 on host wheat will spread its diskDirNum disk directories round robin onto the wheat file systems (wheat1, wheat2, wheat1), while a region using store1 on host millet will use the millet file systems (millet1, millet2, millet3). A region using store2 will use the same path as the system directory.
    To move remote disk directories back to the master directory after a test run, set -DmoveRemoteDirs=true in your batterytest command.
    See also diskDirBaseMapFileName.
  - diskDirBaseMapFileName
```
public static Long diskDirBaseMapFileName
```
    (String(s)) Absolute name of a file containing a mapping of physical host names to lists of absolute base paths to use for each data store. Overrides diskDirBases. Defaults to null (no map file is used).
    Example: hydra.DiskStorePrms-names = store1 store2; hydra.DiskStorePrms-diskDirNum = 3; hydra.DiskStorePrms-diskDirBaseMapFileName = /home/me/bin/diskmap.txt default; where diskmap.txt contains: wheat /export/wheat1/users/me/scratch /export/wheat2/users/me/scratch millet /export/millet1/users/me/scratch /export/millet2/users/me/scratch /export/millet3/users/me/scratch A region using store1 on host wheat will spread its diskDirNum disk directories round robin onto the wheat file systems (wheat1, wheat2, wheat1), while a region using store1 on host millet will use the millet file systems (millet1, millet2, millet3). A process using store2 will use the same path as the system directory.
  - diskDirNum
```
public static Long diskDirNum
```
    (int(s)) Number of disk directories to use for each data store. Defaults to 1.
    The directory names are autogenerated at runtime, numbered consecutively, using the base path(s) determined by diskDirBases and diskDirBaseMapFileName. If there is more than one base path available, the disk directories are assigned to them in a round robin fashion.
  - diskDirSizes
```
public static Long diskDirSizes
```
    (Comma-separated int(s)) Sizes of disk directories to use for each data store, in megabytes. If more than diskDirNum sizes are given, the extra sizes are ignored.
  - maxOplogSize
```
public static Long maxOplogSize
```
    (long(s)) Max oplog size for each disk store, in megabytes.
  - queueSize
```
public static Long queueSize
```
    (int(s)) Queue size for each disk store.
  - timeInterval
```
public static Long timeInterval
```
    (long(s)) Time interval for each disk store, in milliseconds.
  - writeBufferSize
```
public static Long writeBufferSize
```
    (int(s)) Write buffer size for each disk store, in bytes.
- Constructor Detail
  - DiskStorePrms
```
public DiskStorePrms()
```

Class DiskStorePrms

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

names

allowForceCompaction

autoCompact

compactionThreshold

diskDirBases

diskDirBaseMapFileName

diskDirNum

diskDirSizes

maxOplogSize

queueSize

timeInterval

writeBufferSize

Constructor Detail

DiskStorePrms