CachePerfPrms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - cacheperf.CachePerfPrms

Direct Known Subclasses:

QueryPerfPrms
```
public class CachePerfPrms
extends BasePrms
```
A class used to store keys for test configuration settings.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CachePerfPrms.Frequency

Nested Classes
Modifier and Type	Class and Description
`static class`	`CachePerfPrms.Frequency`

Field Summary

Fields
Modifier and Type	Field and Description
`static Long`	`allowConflicts` (boolean) Whether to allow commitConflictException (true), or to rethrow the exception if it occurs (false).
`static Long`	`allowNulls` (boolean) Whether to allow gets to return null values without causing test failure.
`static Long`	`batchSeconds` (int) The number of seconds in each batch for the current task Defaults to -1 (not usable).
`static Long`	`batchSize` (int) The number of iterations in each batch for the current task.
`static Long`	`batchTerminatorClass` (String) The class name to invoke at the termination of each batch.
`static Long`	`batchTerminatorMethod` (String) The method to invoke to check for batch termination.
`static Long`	`bulkOpMapSize` (int) The number of entries in the bulk op map.
`static Long`	`clientNameToBounce` (String) Client name of VM to bounce when executing `#bounceTask`.
`static Long`	`commitPercentage` (int) The percentage of transactions that should be committed (vs.
`static Long`	`destroyAfterGet` (boolean) Whether to destroy objects after gets.
`static Long`	`destroyLocally` (boolean) Whether, when `destroyAfterGet` is true, to destroy locally rather than throughout the distributed system.
`static int`	`DISJOINT_AS_POSSIBLE`
`static Long`	`dummyBulkOps` (boolean) Whether to dummy up each bulk op with regular ops.
`static Long`	`gatewayQueueEntries` (int) The number of keys to put into a gateway queue.
`static Long`	`hitPercentage` (int) The percentage of operations that should be hits.
`static Long`	`hitsAndMisses` (int) Indicates if this test does a mixture of hits & misses Currently only supported at TestConfig level for C cache performance tests.
`static Long`	`interestBatchSize` (int) The number of keys to register interest in at one time.
`static Long`	`invalidateAfterGet` (boolean) Whether to invalidate objects after gets.
`static Long`	`invalidateLocally` (boolean) Whether, when `invalidateAfterGet` is true, to destroy locally rather than throughout the distributed system.
`static Long`	`isMainWorkload` (boolean) Whether this task is the main workload.
`static Long`	`keepDurableInterest` (boolean) Whether or not to keep a durable client connection interest list alive when the durable client disconnects.
`static Long`	`keyAllocation` (String) The method to use when allocating keys to threads for cache operations.
`static Long`	`keyAllocationChunkSize` (int) The size of each "chunk" in a chunked `keyAllocation`.
`static Long`	`keyPercentage` (int) A percentage of maxKeys.
`static Long`	`keyType` (String) Type of keys to create, as a fully qualified classname.
`static Long`	`logInterestRegex` (boolean) Whether to log regular expressions when registering interest in them.
`static Long`	`LRUEvictions` (int) The minimum number of LRU evictions required for termination of warmup, or whatever else test code may choose to use this for.
`static Long`	`LRUEvictionsMaxWaitSec` (int) The maximum amount of time to wait for LRU evictions to terminate warmup, or whatever else test code may choose to use this for.
`static Long`	`LRUEvictionsMinWaitSec` (int) The minimum amount of time to wait for LRU evictions to terminate warmup, or whatever else test code may choose to use this for.
`static Long`	`maxExecutions` (int) The number of executions to carry out.
`static Long`	`maxKeys` (int) The maximum number of keys used in the test, where `maxKeys-1` is the maximum key.
`static Long`	`maxRecentKeys` (int) The maximum number of recent keys to consider.
`static Long`	`numDestroys` (int) The minimum number of destroys required for termination of warmup, or whatever else test code may choose to use this for.
`static Long`	`numDestroysMaxWaitSec` (int) The maximum amount of time to wait for destroys to terminate warmup, or whatever else test code may choose to use this for.
`static Long`	`numDestroysMinWaitSec` (int) The minimum amount of time to wait for destroys to terminate warmup, or whatever else test code may choose to use this for.
`static Long`	`numOperations` (int) The number of operations used in `Terminators.terminateOnNumOperations(cacheperf.CachePerfClient)`.
`static Long`	`numUpdates` (int) Number of updates to do on the same object.
`static Long`	`numWanSites` (int) The number of WAN sites in the test.
`static Long`	`objectType` (String) Type of objects to create, as a fully qualified classname.
`static Long`	`optimizationCount` (int) Whether, and how much, to optimize loops that support optimization.
`static int`	`OWN_KEY`
`static int`	`OWN_KEYS`
`static int`	`OWN_KEYS_CHUNKED`
`static int`	`OWN_KEYS_CHUNKED_RANDOM_WRAP`
`static int`	`OWN_KEYS_RANDOM_WRAP`
`static int`	`OWN_KEYS_WRAP`
`static int`	`PER_ITERATION`
`static int`	`PER_SECOND`
`static int`	`PER_TASK`
`static int`	`PSEUDO_RANDOM_UNIQUE`
`static Long`	`putPercentage` (int) The percentage of operations that should be puts, for use with tasks that mix operations, one of which is put.
`static Long`	`query` (String) The query string.
`static Long`	`queryFromClause` (String) The query from caluse.
`static Long`	`queryIndex` (String) The query index string.
`static Long`	`queryRangeMax` (long) The maximum random value for a query range.
`static Long`	`queryRangeMin` (long) The minimum random value for a query range.
`static Long`	`queryRangeSize` (long) The size of a query range.
`static Long`	`recentKeysPercentage` (int) The percentage (roughly) of operations that will attempt to use a recently used key, rather than obtaining a key with the current key settings (ownKeys, etc.).
`static Long`	`registerDurableInterest` (boolean) Whether or not to register durable (rather than non-durable) interest.
`static Long`	`resetKeysAfterTaskEnds` (boolean) Whether to reset the current key and key count after the task has stopped being scheduled.
`static Long`	`resetKeysBeforeTaskStarts` (boolean) Whether to reset the current key and key count before the task has started being scheduled.
`static Long`	`restartVMs` (boolean) Whether or not to restart VMs after stopping
`static Long`	`restartWaitSec` (int) The number of seconds to wait before restarting a VM that executes a `CachePerfClient.bounceTask()`.
`static int`	`SAME_KEY`
`static int`	`SAME_KEYS`
`static int`	`SAME_KEYS_RANDOM_WRAP`
`static int`	`SAME_KEYS_WRAP`
`static int`	`SCRAMBLED_ZIPFIAN`
`static Long`	`sleepBeforeOp` (boolean) Whether to sleep before doing an operation.
`static Long`	`sleepMs` (int) The time to sleep in milliseconds before doing an operation.
`static Long`	`sleepOpCount` (int) The number of operations to do after sleeping for {link #sleepMs}.
`static Long`	`syncSleepMs` (int) The number of milliseconds to sleep before syncing.
`static Long`	`taskTerminatorClass` (String) The class name to invoke to check for task termination.
`static Long`	`taskTerminatorFrequency` (String) The frequency with which to check for task termination during a task.
`static Long`	`taskTerminatorMethod` (String) The method to invoke to check for task termination.
`static Long`	`trimIterations` (int) The number of warmup iterations to do for the current task.
`static Long`	`trimSeconds` (int) The number of warmup iterations to do for the current task.
`static Long`	`txSize` (int) The number of iterations in each transaction, on a per-thread basis.
`static Long`	`useMeanKill` (boolean) Whether to use a mean kill when executing `CachePerfClient.bounceTask()`.
`static Long`	`useShutDownAllMembers` (boolean) Whether to use shutDownAllMembers to stop vms (for use with disk recovery) Defaults to false.
`static Long`	`useTransactions` (boolean) Whether to encase operations into a transaction.
`static Long`	`validateObjects` (boolean) Whether to validate objects along the way, skipping over null values.
`static Long`	`waitForRecovery` (boolean) Whether to wait for partitioned region redundancy recovery when executing `CachePerfClient.bounceTask()`.
`static Long`	`waitForTrimSignal` (boolean) Whether to wait for the trim signal before proceeding.
`static Long`	`warmupTerminatorClass` (String) The class name to invoke to check for warmup termination.
`static Long`	`warmupTerminatorFrequency` (String) The frequency with which to check for warmup termination during a task.
`static Long`	`warmupTerminatorMethod` (String) The method to invoke to check for warmup termination.
`static Long`	`workIterations` (int) The number of timing iterations to do for the current task.
`static Long`	`workSeconds` (int) The number of timing seconds to do for the current task.
`static int`	`ZIPFIAN`

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

Constructor Summary

Constructors
Constructor and Description

CachePerfPrms()

Constructors
Constructor and Description
`CachePerfPrms()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`allowConflicts()`
`static boolean`	`allowNulls()`
`static boolean`	`destroyAfterGet()`
`static boolean`	`destroyLocally()`
`static int`	`getBatchSeconds()`
`static int`	`getBatchSize()`
`static String`	`getBatchTerminatorClass()`
`static String`	`getBatchTerminatorMethod()`
`static int`	`getBulkOpMapSize()`
`static String`	`getClientNameToBounce()`
`static int`	`getCommitPercentage()`
`static boolean`	`getDummyBulkOps()`
`static int`	`getGatewayQueueEntries()`
`static int`	`getInterestBatchSize()`
`static boolean`	`getKeepDurableInterest()`
`static int`	`getKeyAllocation()`
`static int`	`getKeyAllocationChunkSize()`
`static int`	`getKeyPercentage()`
`static String`	`getKeyType()`
`static int`	`getMaxExecutions()`
`static int`	`getMaxKeys()`
`static int`	`getNumOperations()`
`static int`	`getNumUpdates()`
`static int`	`getNumWanSites()`
`static String`	`getObjectType()`
`static int`	`getOptimizationCount()`
`static int`	`getPutPercentage()`
`static String`	`getQuery()`
`static String`	`getQueryFromClause()`
`static String`	`getQueryIndex()`
`static long`	`getQueryRangeMax()`
`static long`	`getQueryRangeMin()`
`static long`	`getQueryRangeSize()`
`static int`	`getRestartWaitSec()`
`static int`	`getSleepMs()`
`static int`	`getSleepOpCount()`
`static String`	`getTaskTerminatorClass()`
`static CachePerfPrms.Frequency`	`getTaskTerminatorFrequency()`
`static String`	`getTaskTerminatorMethod()`
`static int`	`getTrimIterations()`
`static int`	`getTrimSeconds()`
`static int`	`getTxSize()`
`static String`	`getWarmupTerminatorClass()`
`static CachePerfPrms.Frequency`	`getWarmupTerminatorFrequency()`
`static String`	`getWarmupTerminatorMethod()`
`static int`	`getWorkIterations()`
`static int`	`getWorkSeconds()`
`static boolean`	`invalidateAfterGet()`
`static boolean`	`invalidateLocally()`
`static boolean`	`isMainWorkload()`
`static boolean`	`logInterestRegex()`
`static int`	`LRUEvictions()`
`static int`	`LRUEvictionsMaxWaitSec()`
`static int`	`LRUEvictionsMinWaitSec()`
`static void`	`main(String[] args)`
`static int`	`maxRecentKeys()`
`static int`	`numDestroys()`
`static int`	`numDestroysMaxWaitSec()`
`static int`	`numDestroysMinWaitSec()`
`static int`	`recentKeysPercentage()`
`static boolean`	`registerDurableInterest()`
`static boolean`	`resetKeysAfterTaskEnds(TestTask task)`
`static boolean`	`resetKeysBeforeTaskStarts(TestTask task)`
`static boolean`	`restartVMs()`
`static boolean`	`sleepBeforeOp()`
`static int`	`syncSleepMs()`
`static boolean`	`useMeanKill()`
`static boolean`	`useShutDownAllMembers()`
`static boolean`	`useTransactions()`
`static boolean`	`validateObjects()`
`static boolean`	`waitForRecovery()`
`static boolean`	`waitForTrimSignal()`

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
  - isMainWorkload
```
public static Long isMainWorkload
```
    (boolean) Whether this task is the main workload. Use as a task attribute on the task that is the main workload for the test. Only one task can be the main workload. Not honored by listeners or update event statistics. Defaults to false.
    Transparently shadows the trim interval and statistics for the task as "ops", without adding another call to System.currentTimeMillis().
  - trimSeconds
```
public static Long trimSeconds
```
    (int) The number of warmup iterations to do for the current task. Defaults to -1 (not usable). Not for use with oneof or range.
  - workSeconds
```
public static Long workSeconds
```
    (int) The number of timing seconds to do for the current task. Defaults to -1 (not usable). Not for use with oneof or range.
  - batchSeconds
```
public static Long batchSeconds
```
    (int) The number of seconds in each batch for the current task Defaults to -1 (not usable). Not for use with oneof or range.
  - trimIterations
```
public static Long trimIterations
```
    (int) The number of warmup iterations to do for the current task. This is divided across all threads in the thread group(s) for the task. Defaults to -1 (not usable). Not for use with oneof or range.
  - workIterations
```
public static Long workIterations
```
    (int) The number of timing iterations to do for the current task. This is divided across all threads in the thread group(s) for the task. Defaults to -1 (not usable). Not for use with oneof or range.
  - batchSize
```
public static Long batchSize
```
    (int) The number of iterations in each batch for the current task. This is divided across all threads in the thread group(s) for the task. Defaults to -1 (not usable). Not for use with oneof or range.
  - txSize
```
public static Long txSize
```
    (int) The number of iterations in each transaction, on a per-thread basis. Defaults to 1.
    The batch terminator for a transactional task must have a large enough granularity to allow the task to perform at least txSize operations in each complete batch. Otherwise it is a configuration error. Fewer than txSize operations are allowed in a batch that hits task termination before txSize operations are performed.
  - numOperations
```
public static Long numOperations
```
    (int) The number of operations used in Terminators.terminateOnNumOperations(cacheperf.CachePerfClient). Not for use with oneof or range.
  - keyType
```
public static Long keyType
```
    (String) Type of keys to create, as a fully qualified classname. The class can be any class on the classpath. Defaults to String. Not for use with ONEOF or RANGE or as a task parameter.
    
    See Also:
    
    ObjectHelper
  - keyAllocation
```
public static Long keyAllocation
```
    (String) The method to use when allocating keys to threads for cache operations. Options are "sameKey", "sameKeys", "sameKeysWrap", "sameKeysRandomWrap", "ownKey", "ownKeys", "ownKeysWrap", "ownKeysRandomWrap", "ownKeysChunked", "disjointAsPossible", "pseudoRandomUnique", "zipfian", "scrambledZipfian" Defaults to DEFAULT_KEY_ALLOCATION.
  - SAME_KEY
```
public static final int SAME_KEY
```
    See Also:
    
    Constant Field Values
  - SAME_KEYS
```
public static final int SAME_KEYS
```
    See Also:
    
    Constant Field Values
  - SAME_KEYS_WRAP
```
public static final int SAME_KEYS_WRAP
```
    See Also:
    
    Constant Field Values
  - SAME_KEYS_RANDOM_WRAP
```
public static final int SAME_KEYS_RANDOM_WRAP
```
    See Also:
    
    Constant Field Values
  - OWN_KEY
```
public static final int OWN_KEY
```
    See Also:
    
    Constant Field Values
  - OWN_KEYS
```
public static final int OWN_KEYS
```
    See Also:
    
    Constant Field Values
  - OWN_KEYS_WRAP
```
public static final int OWN_KEYS_WRAP
```
    See Also:
    
    Constant Field Values
  - OWN_KEYS_RANDOM_WRAP
```
public static final int OWN_KEYS_RANDOM_WRAP
```
    See Also:
    
    Constant Field Values
  - OWN_KEYS_CHUNKED
```
public static final int OWN_KEYS_CHUNKED
```
    See Also:
    
    Constant Field Values
  - OWN_KEYS_CHUNKED_RANDOM_WRAP
```
public static final int OWN_KEYS_CHUNKED_RANDOM_WRAP
```
    See Also:
    
    Constant Field Values
  - DISJOINT_AS_POSSIBLE
```
public static final int DISJOINT_AS_POSSIBLE
```
    See Also:
    
    Constant Field Values
  - PSEUDO_RANDOM_UNIQUE
```
public static final int PSEUDO_RANDOM_UNIQUE
```
    See Also:
    
    Constant Field Values
  - ZIPFIAN
```
public static final int ZIPFIAN
```
    See Also:
    
    Constant Field Values
  - SCRAMBLED_ZIPFIAN
```
public static final int SCRAMBLED_ZIPFIAN
```
    See Also:
    
    Constant Field Values
  - keyAllocationChunkSize
```
public static Long keyAllocationChunkSize
```
    (int) The size of each "chunk" in a chunked keyAllocation. Defaults to 1. Not for use with oneof or range.
  - maxKeys
```
public static Long maxKeys
```
    (int) The maximum number of keys used in the test, where maxKeys-1 is the maximum key. Required parameter. Not intended for use with oneof or range.
  - resetKeysAfterTaskEnds
```
public static Long resetKeysAfterTaskEnds
```
    (boolean) Whether to reset the current key and key count after the task has stopped being scheduled. Defaults to true.
  - resetKeysBeforeTaskStarts
```
public static Long resetKeysBeforeTaskStarts
```
    (boolean) Whether to reset the current key and key count before the task has started being scheduled. Defaults to true.
  - objectType
```
public static Long objectType
```
    (String) Type of objects to create, as a fully qualified classname. The class can be any supported by ObjectHelper. Defaults to SizedString with the default size.
    
    See Also:
    
    ObjectHelper
  - allowNulls
```
public static Long allowNulls
```
    (boolean) Whether to allow gets to return null values without causing test failure. Defaults to false.
  - validateObjects
```
public static Long validateObjects
```
    (boolean) Whether to validate objects along the way, skipping over null values. Defaults to false. Use allowNulls to configure handling of nulls.
  - invalidateAfterGet
```
public static Long invalidateAfterGet
```
    (boolean) Whether to invalidate objects after gets. Defaults to false. The invalidate is local by default, but can be distributed using invalidateLocally. Not for use with oneof or range. Not for use with oneof or range.
  - invalidateLocally
```
public static Long invalidateLocally
```
    (boolean) Whether, when invalidateAfterGet is true, to destroy locally rather than throughout the distributed system. Defaults to true. Not for use with oneof or range.
  - destroyAfterGet
```
public static Long destroyAfterGet
```
    (boolean) Whether to destroy objects after gets. Defaults to false. The destroy is local by default, but can be distributed using destroyLocally. Not for use with oneof or range.
  - destroyLocally
```
public static Long destroyLocally
```
    (boolean) Whether, when destroyAfterGet is true, to destroy locally rather than throughout the distributed system. Defaults to true. Not for use with oneof or range.
  - sleepBeforeOp
```
public static Long sleepBeforeOp
```
    (boolean) Whether to sleep before doing an operation. Defaults to false. Not for use with oneof or range.
  - sleepMs
```
public static Long sleepMs
```
    (int) The time to sleep in milliseconds before doing an operation. Defaults to 0 (no sleep). Suitable for oneof, range, etc.
  - sleepOpCount
```
public static Long sleepOpCount
```
    (int) The number of operations to do after sleeping for {link #sleepMs}. Defaults to 1 (single op). Suitable for oneof, range, etc.
  - gatewayQueueEntries
```
public static Long gatewayQueueEntries
```
    (int) The number of keys to put into a gateway queue. Default is 1. Not for use with oneof or range.
  - bulkOpMapSize
```
public static Long bulkOpMapSize
```
    (int) The number of entries in the bulk op map. Default is 1.
  - dummyBulkOps
```
public static Long dummyBulkOps
```
    (boolean) Whether to dummy up each bulk op with regular ops. This allows the test to have the same key allocation and memory use as when using bulk ops. Defaults to false.
  - interestBatchSize
```
public static Long interestBatchSize
```
    (int) The number of keys to register interest in at one time. Default is 1. Not for use with oneof or range.
  - logInterestRegex
```
public static Long logInterestRegex
```
    (boolean) Whether to log regular expressions when registering interest in them. Defaults to false. Not for use with oneof or range.
  - registerDurableInterest
```
public static Long registerDurableInterest
```
    (boolean) Whether or not to register durable (rather than non-durable) interest. Defaults to false.
  - keepDurableInterest
```
public static Long keepDurableInterest
```
    (boolean) Whether or not to keep a durable client connection interest list alive when the durable client disconnects.
  - restartVMs
```
public static Long restartVMs
```
    (boolean) Whether or not to restart VMs after stopping
  - batchTerminatorClass
```
public static Long batchTerminatorClass
```
    (String) The class name to invoke at the termination of each batch. Defaults to DEFAULT_CLASS. See also batchTerminatorMethod.
  - batchTerminatorMethod
```
public static Long batchTerminatorMethod
```
    (String) The method to invoke to check for batch termination. The method return type is assumed to be void. Defaults to "terminateOnBatchSize". See also batchTerminatorClass.
  - warmupTerminatorClass
```
public static Long warmupTerminatorClass
```
    (String) The class name to invoke to check for warmup termination. Defaults to DEFAULT_CLASS. See also warmupTerminatorMethod.
  - warmupTerminatorMethod
```
public static Long warmupTerminatorMethod
```
    (String) The method to invoke to check for warmup termination. The method return type must be boolean. Defaults to "terminateOnTrimIterations". See also warmupTerminatorClass.
  - warmupTerminatorFrequency
```
public static Long warmupTerminatorFrequency
```
    (String) The frequency with which to check for warmup termination during a task. Options are "task", "N iterations", "N seconds", where N is an integer. Defaults to "1 iterations".
  - taskTerminatorClass
```
public static Long taskTerminatorClass
```
    (String) The class name to invoke to check for task termination. Defaults to DEFAULT_CLASS. See also taskTerminatorMethod.
  - taskTerminatorMethod
```
public static Long taskTerminatorMethod
```
    (String) The method to invoke to check for task termination. The method return type must be boolean. Defaults to "terminateOnTotalIterations". See also taskTerminatorClass.
  - taskTerminatorFrequency
```
public static Long taskTerminatorFrequency
```
    (String) The frequency with which to check for task termination during a task. Options are "task", "N iterations", "N seconds", where N is an integer. Defaults to "1 iterations".
  - PER_TASK
```
public static final int PER_TASK
```
    See Also:
    
    Constant Field Values
  - PER_ITERATION
```
public static final int PER_ITERATION
```
    See Also:
    
    Constant Field Values
  - PER_SECOND
```
public static final int PER_SECOND
```
    See Also:
    
    Constant Field Values
  - hitsAndMisses
```
public static Long hitsAndMisses
```
    (int) Indicates if this test does a mixture of hits & misses Currently only supported at TestConfig level for C cache performance tests. Defaults to false(0) so existing tests do not need to be modified. Note that it is just simpler for the C tests to deal with ints rather than transforming Java booleans.
  - hitPercentage
```
public static Long hitPercentage
```
    (int) The percentage of operations that should be hits. Note this is currently only used in the C cache performance tests and is only supported on a per test basis (not as a task attribute).
  - putPercentage
```
public static Long putPercentage
```
    (int) The percentage of operations that should be puts, for use with tasks that mix operations, one of which is put. Default is 50.
  - LRUEvictions
```
public static Long LRUEvictions
```
    (int) The minimum number of LRU evictions required for termination of warmup, or whatever else test code may choose to use this for.
  - LRUEvictionsMinWaitSec
```
public static Long LRUEvictionsMinWaitSec
```
    (int) The minimum amount of time to wait for LRU evictions to terminate warmup, or whatever else test code may choose to use this for. Defaults to 0 (no minimum).
    
    See Also:
    
    LRUEvictions
  - LRUEvictionsMaxWaitSec
```
public static Long LRUEvictionsMaxWaitSec
```
    (int) The maximum amount of time to wait for LRU evictions to terminate warmup, or whatever else test code may choose to use this for. Defaults to 0 (no timeout).
    
    See Also:
    
    LRUEvictions
  - numDestroys
```
public static Long numDestroys
```
    (int) The minimum number of destroys required for termination of warmup, or whatever else test code may choose to use this for.
  - numDestroysMinWaitSec
```
public static Long numDestroysMinWaitSec
```
    (int) The minimum amount of time to wait for destroys to terminate warmup, or whatever else test code may choose to use this for. Defaults to 0 (no minimum).
    
    See Also:
    
    numDestroys
  - numDestroysMaxWaitSec
```
public static Long numDestroysMaxWaitSec
```
    (int) The maximum amount of time to wait for destroys to terminate warmup, or whatever else test code may choose to use this for. Defaults to 0 (no timeout).
    
    See Also:
    
    numDestroys
  - numUpdates
```
public static Long numUpdates
```
    (int) Number of updates to do on the same object. Defaults to 1.
    Used by CachePerfClient.updateDataTask(), for example.
  - recentKeysPercentage
```
public static Long recentKeysPercentage
```
    (int) The percentage (roughly) of operations that will attempt to use a recently used key, rather than obtaining a key with the current key settings (ownKeys, etc.). This parameter is an integer between 0 and 100.
  - maxRecentKeys
```
public static Long maxRecentKeys
```
    (int) The maximum number of recent keys to consider. This is used with recentKeysPercentage above, and indicates that maximum number of most recently used keys to consider when choosing a key.
  - syncSleepMs
```
public static Long syncSleepMs
```
    (int) The number of milliseconds to sleep before syncing. This is used to give clients a chance to rest for a while before setting the trim start, which seems to have a positive effect on client apps. Defaults to 0 (no sleep).
  - useTransactions
```
public static Long useTransactions
```
    (boolean) Whether to encase operations into a transaction. Defaults to false.
  - allowConflicts
```
public static Long allowConflicts
```
    (boolean) Whether to allow commitConflictException (true), or to rethrow the exception if it occurs (false). Defaults to false.
  - commitPercentage
```
public static Long commitPercentage
```
    (int) The percentage of transactions that should be committed (vs. rollback).
  - maxExecutions
```
public static Long maxExecutions
```
    (int) The number of executions to carry out. Defaults to 0.
    This parameter is useful when a task needs to do something specific on its last scheduled execution (which cannot be done using maxTimesToRun since there is no way for the task to know it is the final execution). CachePerfClient.bounceTask() uses this parameter to execute a fixed number of times then send a signal to clients executing other tasks so that they all terminate together.
  - restartWaitSec
```
public static Long restartWaitSec
```
    (int) The number of seconds to wait before restarting a VM that executes a CachePerfClient.bounceTask(). Defaults to 0.
  - useMeanKill
```
public static Long useMeanKill
```
    (boolean) Whether to use a mean kill when executing CachePerfClient.bounceTask(). Defaults to false.
  - clientNameToBounce
```
public static Long clientNameToBounce
```
    (String) Client name of VM to bounce when executing #bounceTask. Defaults to null.
  - waitForRecovery
```
public static Long waitForRecovery
```
    (boolean) Whether to wait for partitioned region redundancy recovery when executing CachePerfClient.bounceTask(). Defaults to false.
    NOTE: Requires ResourceObservers to be installed on datahosts.
  - waitForTrimSignal
```
public static Long waitForTrimSignal
```
    (boolean) Whether to wait for the trim signal before proceeding. Defaults to false.
  - useShutDownAllMembers
```
public static Long useShutDownAllMembers
```
    (boolean) Whether to use shutDownAllMembers to stop vms (for use with disk recovery) Defaults to false.
  - query
```
public static Long query
```
    (String) The query string. Handles +=. Defaults to null.
  - queryIndex
```
public static Long queryIndex
```
    (String) The query index string. Handles +=. Defaults to null.
  - queryFromClause
```
public static Long queryFromClause
```
    (String) The query from caluse. Handles +=. Defaults to null.
  - queryRangeMin
```
public static Long queryRangeMin
```
    (long) The minimum random value for a query range. Defaults to 0.
  - queryRangeMax
```
public static Long queryRangeMax
```
    (long) The maximum random value for a query range. Defaults to 0.
  - queryRangeSize
```
public static Long queryRangeSize
```
    (long) The size of a query range. Defaults to 0.
  - numWanSites
```
public static Long numWanSites
```
    (int) The number of WAN sites in the test. Returns 0 if not set, which defaults to the number computed by CachePerfClient.numWanSites. That method which assumes a certain format for client names.
  - keyPercentage
```
public static Long keyPercentage
```
    (int) A percentage of maxKeys. Currently this is used for pseudo-random unique keys, but it can be used for other things as well in the future.
  - optimizationCount
```
public static Long optimizationCount
```
    (int) Whether, and how much, to optimize loops that support optimization. Default to 1, which means no optimization. A value of N > 1 instructs the task to optimize by repeating the primary operation N times in an way that skips object creation and levels of indirection, and only incrementing the stat and its timer once for each batch of N operations.
- Constructor Detail
  - CachePerfPrms
```
public CachePerfPrms()
```
- Method Detail
  - isMainWorkload
```
public static boolean isMainWorkload()
```
  - getTrimSeconds
```
public static int getTrimSeconds()
```
  - getWorkSeconds
```
public static int getWorkSeconds()
```
  - getBatchSeconds
```
public static int getBatchSeconds()
```
  - getTrimIterations
```
public static int getTrimIterations()
```
  - getWorkIterations
```
public static int getWorkIterations()
```
  - getBatchSize
```
public static int getBatchSize()
```
  - getTxSize
```
public static int getTxSize()
```
  - getNumOperations
```
public static int getNumOperations()
```
  - getKeyType
```
public static String getKeyType()
```
  - getKeyAllocation
```
public static int getKeyAllocation()
```
  - getKeyAllocationChunkSize
```
public static int getKeyAllocationChunkSize()
```
  - getMaxKeys
```
public static int getMaxKeys()
```
  - resetKeysAfterTaskEnds
```
public static boolean resetKeysAfterTaskEnds(TestTask task)
```
  - resetKeysBeforeTaskStarts
```
public static boolean resetKeysBeforeTaskStarts(TestTask task)
```
  - getObjectType
```
public static String getObjectType()
```
  - allowNulls
```
public static boolean allowNulls()
```
  - validateObjects
```
public static boolean validateObjects()
```
  - invalidateAfterGet
```
public static boolean invalidateAfterGet()
```
  - invalidateLocally
```
public static boolean invalidateLocally()
```
  - destroyAfterGet
```
public static boolean destroyAfterGet()
```
  - destroyLocally
```
public static boolean destroyLocally()
```
  - sleepBeforeOp
```
public static boolean sleepBeforeOp()
```
  - getSleepMs
```
public static int getSleepMs()
```
  - getSleepOpCount
```
public static int getSleepOpCount()
```
  - getGatewayQueueEntries
```
public static int getGatewayQueueEntries()
```
  - getBulkOpMapSize
```
public static int getBulkOpMapSize()
```
  - getDummyBulkOps
```
public static boolean getDummyBulkOps()
```
  - getInterestBatchSize
```
public static int getInterestBatchSize()
```
  - logInterestRegex
```
public static boolean logInterestRegex()
```
  - registerDurableInterest
```
public static boolean registerDurableInterest()
```
  - getKeepDurableInterest
```
public static boolean getKeepDurableInterest()
```
  - restartVMs
```
public static boolean restartVMs()
```
  - getBatchTerminatorClass
```
public static String getBatchTerminatorClass()
```
  - getBatchTerminatorMethod
```
public static String getBatchTerminatorMethod()
```
  - getWarmupTerminatorClass
```
public static String getWarmupTerminatorClass()
```
  - getWarmupTerminatorMethod
```
public static String getWarmupTerminatorMethod()
```
  - getWarmupTerminatorFrequency
```
public static CachePerfPrms.Frequency getWarmupTerminatorFrequency()
```
  - getTaskTerminatorClass
```
public static String getTaskTerminatorClass()
```
  - getTaskTerminatorMethod
```
public static String getTaskTerminatorMethod()
```
  - getTaskTerminatorFrequency
```
public static CachePerfPrms.Frequency getTaskTerminatorFrequency()
```
  - getPutPercentage
```
public static int getPutPercentage()
```
  - LRUEvictions
```
public static int LRUEvictions()
```
  - LRUEvictionsMinWaitSec
```
public static int LRUEvictionsMinWaitSec()
```
  - LRUEvictionsMaxWaitSec
```
public static int LRUEvictionsMaxWaitSec()
```
  - numDestroys
```
public static int numDestroys()
```
  - numDestroysMinWaitSec
```
public static int numDestroysMinWaitSec()
```
  - numDestroysMaxWaitSec
```
public static int numDestroysMaxWaitSec()
```
  - getNumUpdates
```
public static int getNumUpdates()
```
  - recentKeysPercentage
```
public static int recentKeysPercentage()
```
  - maxRecentKeys
```
public static int maxRecentKeys()
```
  - syncSleepMs
```
public static int syncSleepMs()
```
  - useTransactions
```
public static boolean useTransactions()
```
  - allowConflicts
```
public static boolean allowConflicts()
```
  - getCommitPercentage
```
public static int getCommitPercentage()
```
  - getMaxExecutions
```
public static int getMaxExecutions()
```
  - getRestartWaitSec
```
public static int getRestartWaitSec()
```
  - useMeanKill
```
public static boolean useMeanKill()
```
  - getClientNameToBounce
```
public static String getClientNameToBounce()
```
  - waitForRecovery
```
public static boolean waitForRecovery()
```
  - waitForTrimSignal
```
public static boolean waitForTrimSignal()
```
  - useShutDownAllMembers
```
public static boolean useShutDownAllMembers()
```
  - getQuery
```
public static String getQuery()
```
  - getQueryIndex
```
public static String getQueryIndex()
```
  - getQueryFromClause
```
public static String getQueryFromClause()
```
  - getQueryRangeMin
```
public static long getQueryRangeMin()
```
  - getQueryRangeMax
```
public static long getQueryRangeMax()
```
  - getQueryRangeSize
```
public static long getQueryRangeSize()
```
  - getNumWanSites
```
public static int getNumWanSites()
```
  - getKeyPercentage
```
public static int getKeyPercentage()
```
  - getOptimizationCount
```
public static int getOptimizationCount()
```
  - main
```
public static void main(String[] args)
```

Class CachePerfPrms

Nested Class Summary

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

isMainWorkload

trimSeconds

workSeconds

batchSeconds

trimIterations

workIterations

batchSize

txSize

numOperations

keyType

keyAllocation

SAME_KEY

SAME_KEYS

SAME_KEYS_WRAP

SAME_KEYS_RANDOM_WRAP

OWN_KEY

OWN_KEYS

OWN_KEYS_WRAP

OWN_KEYS_RANDOM_WRAP

OWN_KEYS_CHUNKED

OWN_KEYS_CHUNKED_RANDOM_WRAP

DISJOINT_AS_POSSIBLE

PSEUDO_RANDOM_UNIQUE

ZIPFIAN

SCRAMBLED_ZIPFIAN

keyAllocationChunkSize

maxKeys

resetKeysAfterTaskEnds

resetKeysBeforeTaskStarts

objectType

allowNulls

validateObjects

invalidateAfterGet

invalidateLocally

destroyAfterGet

destroyLocally

sleepBeforeOp

sleepMs

sleepOpCount

gatewayQueueEntries

bulkOpMapSize

dummyBulkOps

interestBatchSize

logInterestRegex

registerDurableInterest

keepDurableInterest

restartVMs

batchTerminatorClass

batchTerminatorMethod

warmupTerminatorClass

warmupTerminatorMethod

warmupTerminatorFrequency

taskTerminatorClass

taskTerminatorMethod

taskTerminatorFrequency

PER_TASK

PER_ITERATION

PER_SECOND

hitsAndMisses

hitPercentage

putPercentage

LRUEvictions

LRUEvictionsMinWaitSec

LRUEvictionsMaxWaitSec

numDestroys

numDestroysMinWaitSec

numDestroysMaxWaitSec

numUpdates

recentKeysPercentage

maxRecentKeys

syncSleepMs