Package io.gatling.plugin.client.http
Class HttpEnterpriseClient
java.lang.Object
io.gatling.plugin.client.http.HttpEnterpriseClient
- All Implemented Interfaces:
EnterpriseClient
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbooleancreatePackage(String packageName, UUID teamId) createSimulation(String simulationName, UUID teamId, String className, UUID pkgId, Map<String, HostByLocation> hostsByLocation) getConcurrentUserMetric(UUID runId, String scenario) getPackage(UUID pkgId) getRequestsSummary(UUID runId) getRunInformation(UUID runId) getSimulation(UUID simulationId) getTeams()startSimulation(UUID simulationId, Map<String, String> systemProperties, Map<String, String> environmentVariables) updateSimulationClassName(UUID simulationId, String className) longuploadPackage(UUID packageId, File file) uploadPackageConfiguration(String jsonConfiguration) longuploadPackageWithChecksum(UUID packageId, File file)
-
Constructor Details
-
HttpEnterpriseClient
public HttpEnterpriseClient(URL baseUrl, String token, String client, String version, URL privateControlPlaneUrl) throws EnterprisePluginException - Parameters:
baseUrl- Base URL for the Gatling Enterprise server, e.g.https://cloud.gatling.iotoken- Authentication token used to access the public APIclient- Name of the calling client, used to verify if it is supported by the APIversion- Version of the calling client, used to verify if it is supported by the APIprivateControlPlaneUrl- (optional) Base URL for a Gatling Enterprise private control plane providing a private repository. If this parameter is provided, packages will be registered as private packages and uploaded through this private control plane.- Throws:
EnterprisePluginException
-
-
Method Details
-
getBaseUrl
- Specified by:
getBaseUrlin interfaceEnterpriseClient
-
getServerInformation
- Specified by:
getServerInformationin interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
getSimulations
- Specified by:
getSimulationsin interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
getSimulation
- Specified by:
getSimulationin interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
getTeams
- Specified by:
getTeamsin interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
getLocations
- Specified by:
getLocationsin interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
getPackages
- Specified by:
getPackagesin interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
getPackage
- Specified by:
getPackagein interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
uploadPackage
- Specified by:
uploadPackagein interfaceEnterpriseClient- Parameters:
packageId- Requiredfile- Required path to the packaged JAR file to upload; required- Throws:
EnterprisePluginException
-
uploadPackageConfiguration
- Specified by:
uploadPackageConfigurationin interfaceEnterpriseClient- Parameters:
jsonConfiguration- Package configuration file, serialized JSON- Returns:
- Package id
- Throws:
EnterprisePluginException
-
startSimulation
public RunSummary startSimulation(UUID simulationId, Map<String, String> systemProperties, Map<String, throws EnterprisePluginExceptionString> environmentVariables) - Specified by:
startSimulationin interfaceEnterpriseClient- Parameters:
simulationId- RequiredsystemProperties- Required (can be an empty map)environmentVariables- Required (can be an empty map)- Throws:
EnterprisePluginException
-
uploadPackageWithChecksum
- Specified by:
uploadPackageWithChecksumin interfaceEnterpriseClient- Parameters:
packageId- Requiredfile- Required- Returns:
- file size if uploaded, -1 when checksum are equals
- Throws:
EnterprisePluginException
-
updateSimulationClassName
public SimulationClassName updateSimulationClassName(UUID simulationId, String className) throws EnterprisePluginException - Specified by:
updateSimulationClassNamein interfaceEnterpriseClient- Parameters:
simulationId- RequiredclassName- Required- Returns:
- updated simulation
- Throws:
EnterprisePluginException
-
createSimulation
public Simulation createSimulation(String simulationName, UUID teamId, String className, UUID pkgId, Map<String, HostByLocation> hostsByLocation) throws EnterprisePluginException- Specified by:
createSimulationin interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
createPackage
- Specified by:
createPackagein interfaceEnterpriseClient- Throws:
EnterprisePluginException
-
getRunInformation
- Specified by:
getRunInformationin interfaceEnterpriseClient- Parameters:
runId- Required- Returns:
- Information on the requested run
- Throws:
EnterprisePluginException
-
getConcurrentUserMetric
public List<Series> getConcurrentUserMetric(UUID runId, String scenario) throws EnterprisePluginException - Specified by:
getConcurrentUserMetricin interfaceEnterpriseClient- Parameters:
runId- Requiredscenario- Required- Throws:
EnterprisePluginException
-
getRequestsSummary
- Specified by:
getRequestsSummaryin interfaceEnterpriseClient- Parameters:
runId- Required- Throws:
EnterprisePluginException
-
abortRun
- Specified by:
abortRunin interfaceEnterpriseClient- Parameters:
runId- Required- Returns:
- false if there was no run to abort (run does not exist or is already stopped)
- Throws:
EnterprisePluginException
-