Package org.openjdk.jmh.runner.options
Class OptionsBuilder
- java.lang.Object
-
- org.openjdk.jmh.runner.options.OptionsBuilder
-
- All Implemented Interfaces:
Serializable
,ChainedOptionsBuilder
,Options
public class OptionsBuilder extends Object implements Options, ChainedOptionsBuilder
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description OptionsBuilder()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ChainedOptionsBuilder
addProfiler(Class<? extends Profiler> prof)
Add the profiler in the runChainedOptionsBuilder
addProfiler(Class<? extends Profiler> prof, String initLine)
Add the profiler in the runChainedOptionsBuilder
addProfiler(String prof)
Add the profiler in the runChainedOptionsBuilder
addProfiler(String prof, String initLine)
Add the profiler in the runOptions
build()
Produce the final OptionsChainedOptionsBuilder
detectJvmArgs()
Autodetect forked JVM arguments from the parent VM.ChainedOptionsBuilder
exclude(String regexp)
Exclude benchmarks from the run (Can be used multiple times)ChainedOptionsBuilder
forks(int value)
Number of forks to use in the runCollection<Mode>
getBenchModes()
Benchmarks modes to execute.List<String>
getExcludes()
Which benchmarks to omit?Optional<Integer>
getForkCount()
Fork countList<String>
getIncludes()
Which benchmarks to execute?Optional<String>
getJvm()
JVM executable to use for forksOptional<Collection<String>>
getJvmArgs()
JVM parameters to use with forksOptional<Collection<String>>
getJvmArgsAppend()
JVM parameters to use with forks (these options will be appended after any other JVM option)Optional<Collection<String>>
getJvmArgsPrepend()
JVM parameters to use with forks (these options will be prepended before any other JVM option)Optional<Integer>
getMeasurementBatchSize()
Number of batch size for measurementOptional<Integer>
getMeasurementIterations()
Number of measurement iterationsOptional<TimeValue>
getMeasurementTime()
The duration for measurement iterationsOptional<Integer>
getOperationsPerInvocation()
Operations per invocation.Optional<String>
getOutput()
Which file to use for dumping the outputOptional<Collection<String>>
getParameter(String name)
The overridden value of the parameter.List<ProfilerConfig>
getProfilers()
Profilers to use for the run.Optional<String>
getResult()
Which file to use for dumping the resultOptional<ResultFormatType>
getResultFormat()
Result format to useOptional<int[]>
getThreadGroups()
Thread subgroups distribution.Optional<Integer>
getThreads()
Number of threads to runOptional<TimeValue>
getTimeout()
Timeout: how long to wait for an iteration to complete.Optional<TimeUnit>
getTimeUnit()
Timeunit to use in units.Optional<Integer>
getWarmupBatchSize()
Number of batch size for warmupOptional<Integer>
getWarmupForkCount()
Number of initial forks to ignore the results forList<String>
getWarmupIncludes()
Which benchmarks to warmup before doing the run.Optional<Integer>
getWarmupIterations()
Number of warmup iterationsOptional<WarmupMode>
getWarmupMode()
Warmup mode.Optional<TimeValue>
getWarmupTime()
The duration for warmup iterationsChainedOptionsBuilder
include(String regexp)
Include benchmark in the run (Can be used multiple times)ChainedOptionsBuilder
includeWarmup(String regexp)
What other benchmarks to warmup along the wayChainedOptionsBuilder
jvm(String path)
Forked JVM to use.ChainedOptionsBuilder
jvmArgs(String... value)
Forked JVM arguments.ChainedOptionsBuilder
jvmArgsAppend(String... value)
Append forked JVM arguments: These options go after other options.ChainedOptionsBuilder
jvmArgsPrepend(String... value)
Prepend forked JVM arguments: These options go before any other options.ChainedOptionsBuilder
measurementBatchSize(int value)
How large measurement batchSize should be?ChainedOptionsBuilder
measurementIterations(int count)
How many measurement measurementIterations to doChainedOptionsBuilder
measurementTime(TimeValue value)
How long each measurement iteration should take?ChainedOptionsBuilder
mode(Mode mode)
Benchmark mode.ChainedOptionsBuilder
operationsPerInvocation(int opsPerInv)
Operations per invocation.ChainedOptionsBuilder
output(String filename)
Output filename to write the run log toChainedOptionsBuilder
param(String name, String... values)
Set benchmark parameter values.ChainedOptionsBuilder
parent(Options other)
Override the defaults from the given option.ChainedOptionsBuilder
result(String filename)
Output filename to write the result toChainedOptionsBuilder
resultFormat(ResultFormatType type)
ResultFormatType to use in the runOptional<Boolean>
shouldDoGC()
Should force GC between iterations?ChainedOptionsBuilder
shouldDoGC(boolean value)
Should do GC between measurementIterations?Optional<Boolean>
shouldFailOnError()
Should harness terminate on first error encountered?ChainedOptionsBuilder
shouldFailOnError(boolean value)
Should fail on first benchmark error?Optional<Boolean>
shouldSyncIterations()
Should synchronize iterations?ChainedOptionsBuilder
syncIterations(boolean value)
Should synchronize measurementIterations?ChainedOptionsBuilder
threadGroups(int... groups)
Subgroups thread distribution.ChainedOptionsBuilder
threads(int count)
Number of threads to run the benchmark inChainedOptionsBuilder
timeout(TimeValue value)
How long to wait for iteration execution?ChainedOptionsBuilder
timeUnit(TimeUnit tu)
Timeunit to use in resultsOptional<VerboseMode>
verbosity()
How verbose should we be?ChainedOptionsBuilder
verbosity(VerboseMode mode)
Control verbosity level.ChainedOptionsBuilder
warmupBatchSize(int value)
How large warmup batchSize should be?ChainedOptionsBuilder
warmupForks(int value)
Number of ignored forksChainedOptionsBuilder
warmupIterations(int value)
How many warmup iterations to do?ChainedOptionsBuilder
warmupMode(WarmupMode mode)
Warmup mode to useChainedOptionsBuilder
warmupTime(TimeValue value)
How long each warmup iteration should take?
-
-
-
Method Detail
-
build
public Options build()
Description copied from interface:ChainedOptionsBuilder
Produce the final Options- Specified by:
build
in interfaceChainedOptionsBuilder
- Returns:
- options object.
-
parent
public ChainedOptionsBuilder parent(Options other)
Description copied from interface:ChainedOptionsBuilder
Override the defaults from the given option. You may use this only once.- Specified by:
parent
in interfaceChainedOptionsBuilder
- Parameters:
other
- options to base on- Returns:
- builder
-
include
public ChainedOptionsBuilder include(String regexp)
Description copied from interface:ChainedOptionsBuilder
Include benchmark in the run (Can be used multiple times)- Specified by:
include
in interfaceChainedOptionsBuilder
- Parameters:
regexp
- to match benchmarks against- Returns:
- builder
- See Also:
Defaults.INCLUDE_BENCHMARKS
-
getIncludes
public List<String> getIncludes()
Description copied from interface:Options
Which benchmarks to execute?- Specified by:
getIncludes
in interfaceOptions
- Returns:
- list of regexps matching the requested benchmarks
-
exclude
public ChainedOptionsBuilder exclude(String regexp)
Description copied from interface:ChainedOptionsBuilder
Exclude benchmarks from the run (Can be used multiple times)- Specified by:
exclude
in interfaceChainedOptionsBuilder
- Parameters:
regexp
- to match benchmark against- Returns:
- builder
-
getExcludes
public List<String> getExcludes()
Description copied from interface:Options
Which benchmarks to omit?- Specified by:
getExcludes
in interfaceOptions
- Returns:
- list of regexps matching the ignored benchmarks
-
output
public ChainedOptionsBuilder output(String filename)
Description copied from interface:ChainedOptionsBuilder
Output filename to write the run log to- Specified by:
output
in interfaceChainedOptionsBuilder
- Parameters:
filename
- file name- Returns:
- builder
-
getOutput
public Optional<String> getOutput()
Description copied from interface:Options
Which file to use for dumping the output
-
resultFormat
public ChainedOptionsBuilder resultFormat(ResultFormatType type)
Description copied from interface:ChainedOptionsBuilder
ResultFormatType to use in the run- Specified by:
resultFormat
in interfaceChainedOptionsBuilder
- Parameters:
type
- resultformat type- Returns:
- builder
- See Also:
Defaults.RESULT_FORMAT
-
getResultFormat
public Optional<ResultFormatType> getResultFormat()
Description copied from interface:Options
Result format to use- Specified by:
getResultFormat
in interfaceOptions
- Returns:
- format type
-
result
public ChainedOptionsBuilder result(String filename)
Description copied from interface:ChainedOptionsBuilder
Output filename to write the result to- Specified by:
result
in interfaceChainedOptionsBuilder
- Parameters:
filename
- file name- Returns:
- builder
- See Also:
Defaults.RESULT_FILE_PREFIX
-
getResult
public Optional<String> getResult()
Description copied from interface:Options
Which file to use for dumping the result
-
shouldDoGC
public ChainedOptionsBuilder shouldDoGC(boolean value)
Description copied from interface:ChainedOptionsBuilder
Should do GC between measurementIterations?- Specified by:
shouldDoGC
in interfaceChainedOptionsBuilder
- Parameters:
value
- flag- Returns:
- builder
- See Also:
Defaults.DO_GC
-
shouldDoGC
public Optional<Boolean> shouldDoGC()
Description copied from interface:Options
Should force GC between iterations?- Specified by:
shouldDoGC
in interfaceOptions
- Returns:
- should GC?
-
addProfiler
public ChainedOptionsBuilder addProfiler(Class<? extends Profiler> prof)
Description copied from interface:ChainedOptionsBuilder
Add the profiler in the run- Specified by:
addProfiler
in interfaceChainedOptionsBuilder
- Parameters:
prof
- profiler class- Returns:
- builder
-
addProfiler
public ChainedOptionsBuilder addProfiler(Class<? extends Profiler> prof, String initLine)
Description copied from interface:ChainedOptionsBuilder
Add the profiler in the run- Specified by:
addProfiler
in interfaceChainedOptionsBuilder
- Parameters:
prof
- profiler classinitLine
- profiler options initialization line- Returns:
- builder
-
addProfiler
public ChainedOptionsBuilder addProfiler(String prof)
Description copied from interface:ChainedOptionsBuilder
Add the profiler in the run- Specified by:
addProfiler
in interfaceChainedOptionsBuilder
- Parameters:
prof
- profiler class name, or profiler alias- Returns:
- builder
-
addProfiler
public ChainedOptionsBuilder addProfiler(String prof, String initLine)
Description copied from interface:ChainedOptionsBuilder
Add the profiler in the run- Specified by:
addProfiler
in interfaceChainedOptionsBuilder
- Parameters:
prof
- profiler class name, or profiler aliasinitLine
- profiler options initialization line- Returns:
- builder
-
getProfilers
public List<ProfilerConfig> getProfilers()
Description copied from interface:Options
Profilers to use for the run. Profilers will start in the order specified by collection, and will stop in the reverse order.- Specified by:
getProfilers
in interfaceOptions
- Returns:
- profilers to use; empty collection if no profilers are required
-
verbosity
public ChainedOptionsBuilder verbosity(VerboseMode mode)
Description copied from interface:ChainedOptionsBuilder
Control verbosity level.- Specified by:
verbosity
in interfaceChainedOptionsBuilder
- Parameters:
mode
- flag- Returns:
- builder
- See Also:
Defaults.VERBOSITY
-
verbosity
public Optional<VerboseMode> verbosity()
Description copied from interface:Options
How verbose should we be?
-
shouldFailOnError
public ChainedOptionsBuilder shouldFailOnError(boolean value)
Description copied from interface:ChainedOptionsBuilder
Should fail on first benchmark error?- Specified by:
shouldFailOnError
in interfaceChainedOptionsBuilder
- Parameters:
value
- flag- Returns:
- builder
- See Also:
Defaults.FAIL_ON_ERROR
-
shouldFailOnError
public Optional<Boolean> shouldFailOnError()
Description copied from interface:Options
Should harness terminate on first error encountered?- Specified by:
shouldFailOnError
in interfaceOptions
- Returns:
- should terminate?
-
threads
public ChainedOptionsBuilder threads(int count)
Description copied from interface:ChainedOptionsBuilder
Number of threads to run the benchmark in- Specified by:
threads
in interfaceChainedOptionsBuilder
- Parameters:
count
- number of threads- Returns:
- builder
- See Also:
Threads
,Defaults.THREADS
-
getThreads
public Optional<Integer> getThreads()
Description copied from interface:Options
Number of threads to run- Specified by:
getThreads
in interfaceOptions
- Returns:
- number of threads; 0 to use maximum number of threads
- See Also:
Threads
-
threadGroups
public ChainedOptionsBuilder threadGroups(int... groups)
Description copied from interface:ChainedOptionsBuilder
Subgroups thread distribution.- Specified by:
threadGroups
in interfaceChainedOptionsBuilder
- Parameters:
groups
- thread distribution- Returns:
- builder
- See Also:
Group
,GroupThreads
-
getThreadGroups
public Optional<int[]> getThreadGroups()
Description copied from interface:Options
Thread subgroups distribution.- Specified by:
getThreadGroups
in interfaceOptions
- Returns:
- array of thread ratios
- See Also:
Group
,GroupThreads
-
syncIterations
public ChainedOptionsBuilder syncIterations(boolean value)
Description copied from interface:ChainedOptionsBuilder
Should synchronize measurementIterations?- Specified by:
syncIterations
in interfaceChainedOptionsBuilder
- Parameters:
value
- flag- Returns:
- builder
- See Also:
Defaults.SYNC_ITERATIONS
-
shouldSyncIterations
public Optional<Boolean> shouldSyncIterations()
Description copied from interface:Options
Should synchronize iterations?- Specified by:
shouldSyncIterations
in interfaceOptions
- Returns:
- should we?
-
warmupIterations
public ChainedOptionsBuilder warmupIterations(int value)
Description copied from interface:ChainedOptionsBuilder
How many warmup iterations to do?- Specified by:
warmupIterations
in interfaceChainedOptionsBuilder
- Parameters:
value
- flag- Returns:
- builder
- See Also:
Warmup
,Defaults.WARMUP_ITERATIONS
,Defaults.WARMUP_ITERATIONS_SINGLESHOT
-
getWarmupIterations
public Optional<Integer> getWarmupIterations()
Description copied from interface:Options
Number of warmup iterations- Specified by:
getWarmupIterations
in interfaceOptions
- Returns:
- number of warmup iterations
- See Also:
Warmup
-
warmupBatchSize
public ChainedOptionsBuilder warmupBatchSize(int value)
Description copied from interface:ChainedOptionsBuilder
How large warmup batchSize should be?- Specified by:
warmupBatchSize
in interfaceChainedOptionsBuilder
- Parameters:
value
- batch size- Returns:
- builder
- See Also:
Warmup
,Defaults.WARMUP_BATCHSIZE
-
getWarmupBatchSize
public Optional<Integer> getWarmupBatchSize()
Description copied from interface:Options
Number of batch size for warmup- Specified by:
getWarmupBatchSize
in interfaceOptions
- Returns:
- number of batch size for warmup
- See Also:
Warmup
-
warmupTime
public ChainedOptionsBuilder warmupTime(TimeValue value)
Description copied from interface:ChainedOptionsBuilder
How long each warmup iteration should take?- Specified by:
warmupTime
in interfaceChainedOptionsBuilder
- Parameters:
value
- time- Returns:
- builder
- See Also:
Warmup
,Defaults.WARMUP_TIME
-
getWarmupTime
public Optional<TimeValue> getWarmupTime()
Description copied from interface:Options
The duration for warmup iterations- Specified by:
getWarmupTime
in interfaceOptions
- Returns:
- duration
- See Also:
Warmup
-
warmupMode
public ChainedOptionsBuilder warmupMode(WarmupMode mode)
Description copied from interface:ChainedOptionsBuilder
Warmup mode to use- Specified by:
warmupMode
in interfaceChainedOptionsBuilder
- Parameters:
mode
- to use- Returns:
- builder
- See Also:
Defaults.WARMUP_MODE
-
getWarmupMode
public Optional<WarmupMode> getWarmupMode()
Description copied from interface:Options
Warmup mode.- Specified by:
getWarmupMode
in interfaceOptions
- Returns:
- warmup mode
- See Also:
WarmupMode
-
includeWarmup
public ChainedOptionsBuilder includeWarmup(String regexp)
Description copied from interface:ChainedOptionsBuilder
What other benchmarks to warmup along the way- Specified by:
includeWarmup
in interfaceChainedOptionsBuilder
- Parameters:
regexp
- to match benchmarks against- Returns:
- builder
-
getWarmupIncludes
public List<String> getWarmupIncludes()
Description copied from interface:Options
Which benchmarks to warmup before doing the run.- Specified by:
getWarmupIncludes
in interfaceOptions
- Returns:
- list of regexps matching the relevant benchmarks; empty if no benchmarks are defined
-
measurementIterations
public ChainedOptionsBuilder measurementIterations(int count)
Description copied from interface:ChainedOptionsBuilder
How many measurement measurementIterations to do- Specified by:
measurementIterations
in interfaceChainedOptionsBuilder
- Parameters:
count
- number of iterations- Returns:
- builder
- See Also:
Measurement
,Defaults.MEASUREMENT_ITERATIONS
,Defaults.MEASUREMENT_ITERATIONS_SINGLESHOT
-
getMeasurementIterations
public Optional<Integer> getMeasurementIterations()
Description copied from interface:Options
Number of measurement iterations- Specified by:
getMeasurementIterations
in interfaceOptions
- Returns:
- number of measurement iterations
- See Also:
Measurement
-
measurementTime
public ChainedOptionsBuilder measurementTime(TimeValue value)
Description copied from interface:ChainedOptionsBuilder
How long each measurement iteration should take?- Specified by:
measurementTime
in interfaceChainedOptionsBuilder
- Parameters:
value
- time- Returns:
- builder
- See Also:
Measurement
,Defaults.MEASUREMENT_TIME
-
getMeasurementTime
public Optional<TimeValue> getMeasurementTime()
Description copied from interface:Options
The duration for measurement iterations- Specified by:
getMeasurementTime
in interfaceOptions
- Returns:
- duration
- See Also:
Measurement
-
measurementBatchSize
public ChainedOptionsBuilder measurementBatchSize(int value)
Description copied from interface:ChainedOptionsBuilder
How large measurement batchSize should be?- Specified by:
measurementBatchSize
in interfaceChainedOptionsBuilder
- Parameters:
value
- batch size- Returns:
- builder
- See Also:
Measurement
,Defaults.MEASUREMENT_BATCHSIZE
-
getMeasurementBatchSize
public Optional<Integer> getMeasurementBatchSize()
Description copied from interface:Options
Number of batch size for measurement- Specified by:
getMeasurementBatchSize
in interfaceOptions
- Returns:
- number of batch size for measurement
- See Also:
Measurement
-
mode
public ChainedOptionsBuilder mode(Mode mode)
Description copied from interface:ChainedOptionsBuilder
Benchmark mode. (Can be used multiple times)- Specified by:
mode
in interfaceChainedOptionsBuilder
- Parameters:
mode
- benchmark mode- Returns:
- builder
- See Also:
BenchmarkMode
,Defaults.BENCHMARK_MODE
-
getBenchModes
public Collection<Mode> getBenchModes()
Description copied from interface:Options
Benchmarks modes to execute.- Specified by:
getBenchModes
in interfaceOptions
- Returns:
- modes to execute the benchmarks in; empty to use the default modes
- See Also:
BenchmarkMode
-
timeUnit
public ChainedOptionsBuilder timeUnit(TimeUnit tu)
Description copied from interface:ChainedOptionsBuilder
Timeunit to use in results- Specified by:
timeUnit
in interfaceChainedOptionsBuilder
- Parameters:
tu
- time unit- Returns:
- builder
- See Also:
OutputTimeUnit
,Defaults.OUTPUT_TIMEUNIT
-
getTimeUnit
public Optional<TimeUnit> getTimeUnit()
Description copied from interface:Options
Timeunit to use in units.- Specified by:
getTimeUnit
in interfaceOptions
- Returns:
- timeunit
- See Also:
OutputTimeUnit
-
operationsPerInvocation
public ChainedOptionsBuilder operationsPerInvocation(int opsPerInv)
Description copied from interface:ChainedOptionsBuilder
Operations per invocation.- Specified by:
operationsPerInvocation
in interfaceChainedOptionsBuilder
- Parameters:
opsPerInv
- operations per invocation.- Returns:
- builder
- See Also:
OperationsPerInvocation
,Defaults.OPS_PER_INVOCATION
-
getOperationsPerInvocation
public Optional<Integer> getOperationsPerInvocation()
Description copied from interface:Options
Operations per invocation.- Specified by:
getOperationsPerInvocation
in interfaceOptions
- Returns:
- operations per invocation.
- See Also:
OperationsPerInvocation
-
forks
public ChainedOptionsBuilder forks(int value)
Description copied from interface:ChainedOptionsBuilder
Number of forks to use in the run- Specified by:
forks
in interfaceChainedOptionsBuilder
- Parameters:
value
- number of forks- Returns:
- builder
- See Also:
Fork
,Defaults.MEASUREMENT_FORKS
-
getForkCount
public Optional<Integer> getForkCount()
Description copied from interface:Options
Fork count- Specified by:
getForkCount
in interfaceOptions
- Returns:
- fork count; 0, to prohibit forking
- See Also:
Fork
-
warmupForks
public ChainedOptionsBuilder warmupForks(int value)
Description copied from interface:ChainedOptionsBuilder
Number of ignored forks- Specified by:
warmupForks
in interfaceChainedOptionsBuilder
- Parameters:
value
- number of ignored forks- Returns:
- builder
- See Also:
Fork
,Defaults.WARMUP_FORKS
-
getWarmupForkCount
public Optional<Integer> getWarmupForkCount()
Description copied from interface:Options
Number of initial forks to ignore the results for- Specified by:
getWarmupForkCount
in interfaceOptions
- Returns:
- initial fork count; 0, to disable
- See Also:
Fork
-
jvm
public ChainedOptionsBuilder jvm(String path)
Description copied from interface:ChainedOptionsBuilder
Forked JVM to use.- Specified by:
jvm
in interfaceChainedOptionsBuilder
- Parameters:
path
- path to /bin/java- Returns:
- builder
-
getJvm
public Optional<String> getJvm()
Description copied from interface:Options
JVM executable to use for forks
-
jvmArgs
public ChainedOptionsBuilder jvmArgs(String... value)
Description copied from interface:ChainedOptionsBuilder
Forked JVM arguments.- Specified by:
jvmArgs
in interfaceChainedOptionsBuilder
- Parameters:
value
- arguments to add to the run- Returns:
- builder
- See Also:
Fork
-
getJvmArgs
public Optional<Collection<String>> getJvmArgs()
Description copied from interface:Options
JVM parameters to use with forks- Specified by:
getJvmArgs
in interfaceOptions
- Returns:
- JVM parameters
- See Also:
Fork
-
jvmArgsAppend
public ChainedOptionsBuilder jvmArgsAppend(String... value)
Description copied from interface:ChainedOptionsBuilder
Append forked JVM arguments: These options go after other options.- Specified by:
jvmArgsAppend
in interfaceChainedOptionsBuilder
- Parameters:
value
- arguments to add to the run- Returns:
- builder
- See Also:
Fork
-
getJvmArgsAppend
public Optional<Collection<String>> getJvmArgsAppend()
Description copied from interface:Options
JVM parameters to use with forks (these options will be appended after any other JVM option)- Specified by:
getJvmArgsAppend
in interfaceOptions
- Returns:
- JVM parameters
- See Also:
Fork
-
jvmArgsPrepend
public ChainedOptionsBuilder jvmArgsPrepend(String... value)
Description copied from interface:ChainedOptionsBuilder
Prepend forked JVM arguments: These options go before any other options.- Specified by:
jvmArgsPrepend
in interfaceChainedOptionsBuilder
- Parameters:
value
- arguments to add to the run- Returns:
- builder
- See Also:
Fork
-
getJvmArgsPrepend
public Optional<Collection<String>> getJvmArgsPrepend()
Description copied from interface:Options
JVM parameters to use with forks (these options will be prepended before any other JVM option)- Specified by:
getJvmArgsPrepend
in interfaceOptions
- Returns:
- JVM parameters
- See Also:
Fork
-
detectJvmArgs
public ChainedOptionsBuilder detectJvmArgs()
Description copied from interface:ChainedOptionsBuilder
Autodetect forked JVM arguments from the parent VM. Overrides the jvmArgs(...) value.- Specified by:
detectJvmArgs
in interfaceChainedOptionsBuilder
- Returns:
- builder
-
getParameter
public Optional<Collection<String>> getParameter(String name)
Description copied from interface:Options
The overridden value of the parameter.- Specified by:
getParameter
in interfaceOptions
- Parameters:
name
- parameter name- Returns:
- parameter
- See Also:
Param
-
param
public ChainedOptionsBuilder param(String name, String... values)
Description copied from interface:ChainedOptionsBuilder
Set benchmark parameter values. The parameter values would be taken in the order given by user.- Specified by:
param
in interfaceChainedOptionsBuilder
- Parameters:
name
- parametervalues
- sequence of values to set- Returns:
- builder
- See Also:
Param
-
timeout
public ChainedOptionsBuilder timeout(TimeValue value)
Description copied from interface:ChainedOptionsBuilder
How long to wait for iteration execution?- Specified by:
timeout
in interfaceChainedOptionsBuilder
- Parameters:
value
- time- Returns:
- builder
- See Also:
Defaults.TIMEOUT
-
getTimeout
public Optional<TimeValue> getTimeout()
Description copied from interface:Options
Timeout: how long to wait for an iteration to complete.- Specified by:
getTimeout
in interfaceOptions
- Returns:
- duration
-
-