RunnerOptions class
An object of this class is used to define options for VisualGridRunner or ClassicRunner.
Import statement
import com.applitools.eyes.visualgrid.services.RunnerOptions;
Example
The example below demonstrates the creation of a VisualGridRunner instance. It is initialized with a call to the constructor RunnerOptions. A call to testConcurrency is then appended with a parameter of 10. This runner instance is passed to the Eyes instance when it is created. The end effect is that the runner manages the workflow and concurrency of all Eyes instances that are initialized with that runner. Passing a parameter of 10 means that the runner limits the concurrency to a maximum of 10 active test executions.
private EyesRunner runner = null;
runner = new VisualGridRunner(new RunnerOptions().testConcurrency(concurrentSessions));
eyes = new Eyes(runner);
apiKey method
Syntax
RunnerOptions value = obj.apiKey(apiKey);
Parameters
apiKey
Type: String
Your API key.
Return value
Type: RunnerOptions
This method returns the object that called it so that it can be used to call other methods supported by this class in a fluent API style.
autProxy method
Syntax
RunnerOptions value = obj.autProxy(autProxy);
Parameters
autProxy
Type: AbstractProxySettings
An object that defines how to interact with the proxy server.
Return value
Type: RunnerOptions
This method returns the object that called it so that it can be used to call other methods supported by this class in a fluent API style.
proxy method
Syntax
RunnerOptions value = obj.proxy(proxySettings);
Parameters
proxySettings
Type: AbstractProxySettings
An object that defines how to interact with the proxy server.
Return value
Type: RunnerOptions
This method returns the object that called it so that it can be used to call other methods supported by this class in a fluent API style.
serverUrl method
Syntax
RunnerOptions value = obj.serverUrl(serverUrl);
Parameters
serverUrl
Type: String
The URI of your Eyes server in URI format. Pass a value of null to use the default cloud server.
Return value
Type: RunnerOptions
This method returns the object that called it so that it can be used to call other methods supported by this class in a fluent API style.
testConcurrency method
Syntax
runner = new VisualGridRunner(new RunnerOptions().testConcurrency(concurrentSessions));
Parameters
testConcurrency
Type: int
The maximum number of Eyes tests that can be executed concurrently by this runner.
Return value
Type: RunnerOptions