UseCase3Prms (GemFire XD Java API Documentation)

java.lang.Object
- hydra.BasePrms
- - cacheperf.poc.useCase3_2.UseCase3Prms

```
public class UseCase3Prms
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 UseCase3Prms.CacheOp

static class UseCase3Prms.ClientName

static class UseCase3Prms.RegionName

Nested Classes
Modifier and Type	Class and Description
`static class`	`UseCase3Prms.CacheOp`
`static class`	`UseCase3Prms.ClientName`
`static class`	`UseCase3Prms.RegionName`

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.Long`	`allowNulls` (boolean) Whether to allow gets to return null values without causing test failure.
`static java.lang.Long`	`batchSeconds` (int) The number of seconds in each batch for the current task Defaults to -1 (not usable).
`static java.lang.Long`	`batchTerminatorClass` (String) The class name to invoke at the termination of each batch.
`static java.lang.Long`	`batchTerminatorMethod` (String) The method to invoke to check for batch termination.
`static java.lang.Long`	`bulkOpMapSize` (int) The number of entries in the bulk op map.
`static java.lang.Long`	`cacheOpSpec` (Comma-separated list of String/double pairs) Maps each cacheOp to its percentage, which ranges from 0 to 100.
`static java.lang.Long`	`clientNameToBounce` (String) The logical name of the client to bounce when executing `UseCase3Client.bounceTask()`.
`static java.lang.Long`	`interestBatchSize` (int) The number of keys to register interest in at one time.
`static java.lang.Long`	`interestTotalKeys` (int) The total number of keys to register interest in.
`static java.lang.Long`	`keyAllocation` (String) The method to use when allocating keys to threads for cache operations.
`static java.lang.Long`	`keyAllocationChunkSize` (int) The size of each "chunk" in a chunked `keyAllocation`.
`static java.lang.Long`	`keyType` (String) Type of keys to create, as a fully qualified classname.
`static java.lang.Long`	`objectType` (String) Type of objects to create, as a fully qualified classname.
`static int`	`OWN_KEY`
`static int`	`OWN_KEYS`
`static int`	`OWN_KEYS_CHUNKED`
`static int`	`OWN_KEYS_RANDOM_WRAP`
`static int`	`OWN_KEYS_WRAP`
`static java.lang.Long`	`regionConfigs` (List of String) List of region configs to use when creating regions.
`static java.lang.Long`	`regionName` (String) The name of a region as specified in the `regionSpec`.
`static java.lang.Long`	`regionSpec` (Comma-separated list of String/int pairs) Maps each regionName to its maxKey, which range from 0 to maxKey - 1.
`static java.lang.Long`	`restartWaitSec` (int) The number of seconds to wait before restarting a VM that executes a `UseCase3Client.bounceTask()`.
`static int`	`SAME_KEY`
`static int`	`SAME_KEYS`
`static int`	`SAME_KEYS_RANDOM_WRAP`
`static int`	`SAME_KEYS_WRAP`
`static java.lang.Long`	`sleepAfterOpMs` (int) Time to sleep after each cache operation, in milliseconds.
`static java.lang.Long`	`stopWaitSec` (int) The number of seconds to wait before stopping a VM that executes a `UseCase3Client.bounceTask()`.
`static java.lang.Long`	`taskTerminatorClass` (String) The class name to invoke to check for task termination.
`static java.lang.Long`	`taskTerminatorMethod` (String) The method to invoke to check for task termination.
`static java.lang.Long`	`useMeanKill` (boolean) Whether to use a mean kill when executing `UseCase3Client.bounceTask()`.

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

Constructor Summary

Constructors
Constructor and Description

UseCase3Prms()

Constructors
Constructor and Description
`UseCase3Prms()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`allowNulls()`
`static int`	`getBatchSeconds()`
`static java.lang.String`	`getBatchTerminatorClass()`
`static java.lang.String`	`getBatchTerminatorMethod()`
`static int`	`getBulkOpMapSize()`
`static java.util.Map<UseCase3Prms.CacheOp,java.lang.Double>`	`getCacheOpSpec()`
`static UseCase3Prms.ClientName`	`getClientNameToBounce()`
`static int`	`getInterestBatchSize()`
`static int`	`getInterestTotalKeys()`
`static int`	`getKeyAllocation()`
`static int`	`getKeyAllocationChunkSize()`
`static java.lang.String`	`getKeyType()`
`static java.lang.String`	`getObjectType()`
`static java.util.List`	`getRegionConfigs()`
`static UseCase3Prms.RegionName`	`getRegionName()`
`static java.util.Map<UseCase3Prms.RegionName,java.lang.Integer>`	`getRegionSpec()`
`static int`	`getRestartWaitSec()`
`static int`	`getSleepAfterOpMs()`
`static int`	`getStopWaitSec()`
`static java.lang.String`	`getTaskTerminatorClass()`
`static java.lang.String`	`getTaskTerminatorMethod()`
`static void`	`main(java.lang.String[] args)`
`static boolean`	`useMeanKill()`

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
  - keyType
```
public static java.lang.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 java.lang.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". 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
  - keyAllocationChunkSize
```
public static java.lang.Long keyAllocationChunkSize
```
    (int) The size of each "chunk" in a chunked keyAllocation. Defaults to 1. Not for use with oneof or range.
  - objectType
```
public static java.lang.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 java.lang.Long allowNulls
```
    (boolean) Whether to allow gets to return null values without causing test failure. Defaults to false.
  - batchSeconds
```
public static java.lang.Long batchSeconds
```
    (int) The number of seconds in each batch for the current task Defaults to -1 (not usable).
  - batchTerminatorClass
```
public static java.lang.Long batchTerminatorClass
```
    (String) The class name to invoke at the termination of each batch. Defaults to DEFAULT_CLASS. See also batchTerminatorMethod.
  - batchTerminatorMethod
```
public static java.lang.Long batchTerminatorMethod
```
    (String) The method to invoke to check for batch termination. The method return type is assumed to be void. Defaults to "terminateOnBatchSecodns". See also batchTerminatorClass.
  - taskTerminatorClass
```
public static java.lang.Long taskTerminatorClass
```
    (String) The class name to invoke to check for task termination. Defaults to DEFAULT_CLASS. See also taskTerminatorMethod.
  - taskTerminatorMethod
```
public static java.lang.Long taskTerminatorMethod
```
    (String) The method to invoke to check for task termination. The method return type must be boolean. Defaults to "terminateOnTotalTaskTimeSec". See also taskTerminatorClass.
  - clientNameToBounce
```
public static java.lang.Long clientNameToBounce
```
    (String) The logical name of the client to bounce when executing UseCase3Client.bounceTask().
  - useMeanKill
```
public static java.lang.Long useMeanKill
```
    (boolean) Whether to use a mean kill when executing UseCase3Client.bounceTask(). Defaults to false.
  - stopWaitSec
```
public static java.lang.Long stopWaitSec
```
    (int) The number of seconds to wait before stopping a VM that executes a UseCase3Client.bounceTask(). Defaults to 0.
  - restartWaitSec
```
public static java.lang.Long restartWaitSec
```
    (int) The number of seconds to wait before restarting a VM that executes a UseCase3Client.bounceTask(). Defaults to 0.
  - sleepAfterOpMs
```
public static java.lang.Long sleepAfterOpMs
```
    (int) Time to sleep after each cache operation, in milliseconds. Defaults to 1000.
  - interestTotalKeys
```
public static java.lang.Long interestTotalKeys
```
    (int) The total number of keys to register interest in. Default is 1. Not for use with oneof or range.
  - interestBatchSize
```
public static java.lang.Long interestBatchSize
```
    (int) The number of keys to register interest in at one time. Default is 10. Not for use with oneof or range.
    The size should be sufficient to justify registering with a list.
  - regionConfigs
```
public static java.lang.Long regionConfigs
```
    (List of String) List of region configs to use when creating regions.
  - regionSpec
```
public static java.lang.Long regionSpec
```
    (Comma-separated list of String/int pairs) Maps each regionName to its maxKey, which range from 0 to maxKey - 1. Not intended for use with oneof or range.
  - regionName
```
public static java.lang.Long regionName
```
    (String) The name of a region as specified in the regionSpec.
  - cacheOpSpec
```
public static java.lang.Long cacheOpSpec
```
    (Comma-separated list of String/double pairs) Maps each cacheOp to its percentage, which ranges from 0 to 100. Percentages must add up to 100.
  - bulkOpMapSize
```
public static java.lang.Long bulkOpMapSize
```
    (int) The number of entries in the bulk op map. Default is 1.
- Constructor Detail
  - UseCase3Prms
```
public UseCase3Prms()
```
- Method Detail
  - getKeyType
```
public static java.lang.String getKeyType()
```
  - getKeyAllocation
```
public static int getKeyAllocation()
```
  - getKeyAllocationChunkSize
```
public static int getKeyAllocationChunkSize()
```
  - getObjectType
```
public static java.lang.String getObjectType()
```
  - allowNulls
```
public static boolean allowNulls()
```
  - getBatchSeconds
```
public static int getBatchSeconds()
```
  - getBatchTerminatorClass
```
public static java.lang.String getBatchTerminatorClass()
```
  - getBatchTerminatorMethod
```
public static java.lang.String getBatchTerminatorMethod()
```
  - getTaskTerminatorClass
```
public static java.lang.String getTaskTerminatorClass()
```
  - getTaskTerminatorMethod
```
public static java.lang.String getTaskTerminatorMethod()
```
  - getClientNameToBounce
```
public static UseCase3Prms.ClientName getClientNameToBounce()
```
  - useMeanKill
```
public static boolean useMeanKill()
```
  - getStopWaitSec
```
public static int getStopWaitSec()
```
  - getRestartWaitSec
```
public static int getRestartWaitSec()
```
  - getSleepAfterOpMs
```
public static int getSleepAfterOpMs()
```
  - getInterestTotalKeys
```
public static int getInterestTotalKeys()
```
  - getInterestBatchSize
```
public static int getInterestBatchSize()
```
  - getRegionConfigs
```
public static java.util.List getRegionConfigs()
```
  - getRegionSpec
```
public static java.util.Map<UseCase3Prms.RegionName,java.lang.Integer> getRegionSpec()
```
  - getRegionName
```
public static UseCase3Prms.RegionName getRegionName()
```
  - getCacheOpSpec
```
public static java.util.Map<UseCase3Prms.CacheOp,java.lang.Double> getCacheOpSpec()
```
  - getBulkOpMapSize
```
public static int getBulkOpMapSize()
```
  - main
```
public static void main(java.lang.String[] args)
```

Class UseCase3Prms

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

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

keyAllocationChunkSize

objectType

allowNulls

batchSeconds

batchTerminatorClass

batchTerminatorMethod

taskTerminatorClass

taskTerminatorMethod

clientNameToBounce

useMeanKill

stopWaitSec

restartWaitSec

sleepAfterOpMs

interestTotalKeys

interestBatchSize

regionConfigs

regionSpec

regionName

cacheOpSpec

bulkOpMapSize

Constructor Detail

UseCase3Prms

Method Detail

getKeyType

getKeyAllocation

getKeyAllocationChunkSize

getObjectType

allowNulls

getBatchSeconds

getBatchTerminatorClass

getBatchTerminatorMethod

getTaskTerminatorClass

getTaskTerminatorMethod

getClientNameToBounce

useMeanKill

getStopWaitSec

getRestartWaitSec

getSleepAfterOpMs

getInterestTotalKeys

getInterestBatchSize

getRegionConfigs

getRegionSpec

getRegionName

getCacheOpSpec

getBulkOpMapSize

main