VisualGridRunner class
An object of this class is used to manage multiple Eyes sessions when working with the Ultrafast Grid.
To work without the Ultrafast Grid, use ClassicRunner instead of this class.
Import statement
import com.applitools.eyes.visualgrid.services.VisualGridRunner;
VisualGridRunner method
Syntax
VisualGridRunner runner = new VisualGridRunner(runnerOptions);
Parameters
runnerOptions
Type: RunnerOptions
An object that defines options for the runner. Multiple options can be defined by appending multiple method calls in a fluent style.
Return value
Type: VisualGridRunner
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.
Java
private EyesRunner runner = null; runner = new VisualGridRunner(new RunnerOptions().testConcurrency(concurrentSessions)); eyes = new Eyes(runner);
getAutProxy method
Syntax
AutProxySettings value = visualGridRunner.getAutProxy();
Parameters
This method does not take any parameters.
Return value
Type: AutProxySettings
getIsDisabled method
Syntax
boolean value = visualGridRunner.getIsDisabled();
Parameters
This method does not take any parameters.
Return value
Type: boolean
getProxy method
Syntax
AbstractProxySettings value = visualGridRunner.getProxy();
Parameters
This method does not take any parameters.
Return value
Type: AbstractProxySettings
getStaleElementException method
Syntax
com.applitools.eyes.exceptions.StaleElementReferenceException value = visualGridRunner.getStaleElementException();
Parameters
This method does not take any parameters.
Return value
Type: com.applitools.eyes.exceptions.StaleElementReferenceException
setAutProxy method
Syntax
visualGridRunner.setAutProxy(autProxy);
Parameters
autProxy
Type: AutProxySettings
Description needed.
Return value
Type: void
setIsDisabled method
Syntax
visualGridRunner.setIsDisabled(isDisabled);
Parameters
isDisabled
Type: boolean
Description needed.
Return value
Type: void
setProxy method
Syntax
visualGridRunner.setProxy(proxySettings);
Parameters
proxySettings
Type: AbstractProxySettings
Description needed.
Return value
Type: void