io.gatling.plugin

Interface InteractiveEnterprisePlugin

All Superinterfaces:

java.lang.AutoCloseable

All Known Implementing Classes:

InteractiveEnterprisePluginClient

public interface InteractiveEnterprisePlugin
extends java.lang.AutoCloseable

Enterprise plugin features that require inputs from the user, each method may block awaiting for user input.

All methods can throw an EmptyChoicesException if the API returns an empty set of available choices.

The following exception sub-classes of EnterprisePluginException can be thrown by all methods of this client:

• UnauthorizedApiCallException: invalid authentication token
• ForbiddenApiCallException: authentication token with insufficient privileges
• ApiCallIOException: unexpected IO error
• InvalidApiCallException: invalid input data
• UserQuitException: execution cancelled by the user

Method Summary

Modifier and Type	Method and Description
SimulationStartResult	createOrStartSimulation(java.util.UUID teamId, java.lang.String groupId, java.lang.String artifactId, java.lang.String simulationClass, java.util.List<java.lang.String> discoveredSimulationClasses, java.util.UUID packageId, java.util.Map<java.lang.String,java.lang.String> systemProperties, java.io.File file) Create and start a simulation with given parameters

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

createOrStartSimulation

SimulationStartResult createOrStartSimulation(java.util.UUID teamId,
                                              java.lang.String groupId,
                                              java.lang.String artifactId,
                                              java.lang.String simulationClass,
                                              java.util.List<java.lang.String> discoveredSimulationClasses,
                                              java.util.UUID packageId,
                                              java.util.Map<java.lang.String,java.lang.String> systemProperties,
                                              java.io.File file)
                                       throws EnterprisePluginException,
                                              EmptyChoicesException

Create and start a simulation with given parameters

Parameters:

teamId - Optional, if not null, will be automatically picked

groupId - Optional, if not null, will prefix the proposed package name

artifactId - Optional, if not null, will suffix the proposed package name

simulationClass - Optional, if not null, will be automatically picked

discoveredSimulationClasses - Required, the list of potential simulation classes in the project, required

packageId - Optional, if not null, will be automatically picked when creating a new simulation

systemProperties - Required, can be an empty map; override conflicting system properties when running the simulation

file - Required, path to the packaged JAR file to upload and run

Throws:

SimulationStartException - if simulation start failed after creation

EnterprisePluginException

EmptyChoicesException