Package io.gatling.plugin.client.http.api

Class SimulationsApi

java.lang.Object

io.gatling.plugin.client.http.api.SimulationsApi

public class SimulationsApi
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected final URL	apiUrl
protected static final String	CLOSE
protected static final String	CONTENT_TYPE_HEADER
protected static final String	JSON_MEDIA_TYPE
protected static final String	OCTET_STREAM_MEDIA_TYPE
protected final String	token

Constructor Summary

Constructors

Constructor	Description
SimulationsApi(URL apiUrl, String token)

Method Summary

Modifier and Type	Method	Description
boolean	abortRun(UUID runId)
protected HttpResponse	get(ApiPath path, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
protected <T> T	getJson(ApiPath path, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeRef)
protected <T> T	getJson(ApiPath path, com.fasterxml.jackson.core.type.TypeReference<T> valueTypeRef, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
protected <T> T	getJson(ApiPath path, Class<T> valueType)
protected <T> T	getJson(ApiPath path, Class<T> valueType, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
SimulationResponse	getSimulation(UUID simulationId)
protected HttpResponse	post(ApiPath path, LambdaExceptionUtil.ConsumerWithExceptions<HttpURLConnection,EnterprisePluginException> beforeRequest, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
protected HttpResponse	postJson(ApiPath path, Object body)
protected HttpResponse	postJson(ApiPath path, Object body, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
protected <T> T	postJson(ApiPath path, Object body, Class<T> valueType)
protected HttpResponse	put(ApiPath path, LambdaExceptionUtil.ConsumerWithExceptions<HttpURLConnection,EnterprisePluginException> beforeRequest, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
protected HttpResponse	putJson(ApiPath path, Object body)
protected HttpResponse	putJson(ApiPath path, Object body, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
protected <T> T	putJson(ApiPath path, Object body, Class<T> valueType)
protected <T> T	putJson(ApiPath path, Object body, Class<T> valueType, LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
RunSummaryResponse	startSimulation(UUID simulationId, StartOptionsRequest options)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

CONTENT_TYPE_HEADER

protected static final String CONTENT_TYPE_HEADER

See Also:

• Constant Field Values

OCTET_STREAM_MEDIA_TYPE

protected static final String OCTET_STREAM_MEDIA_TYPE

See Also:

• Constant Field Values

JSON_MEDIA_TYPE

protected static final String JSON_MEDIA_TYPE

See Also:

• Constant Field Values

CLOSE

protected static final String CLOSE

See Also:

• Constant Field Values

apiUrl

protected final URL apiUrl

token

protected final String token

Constructor Details

SimulationsApi

public SimulationsApi(URL apiUrl,
 String token)

Method Details

getSimulation

public SimulationResponse getSimulation(UUID simulationId)
                                 throws EnterprisePluginException

Throws:

EnterprisePluginException

startSimulation

public RunSummaryResponse startSimulation(UUID simulationId,
 StartOptionsRequest options)
                                   throws EnterprisePluginException

Throws:

EnterprisePluginException

abortRun

public boolean abortRun(UUID runId)
                 throws EnterprisePluginException

Throws:

EnterprisePluginException

get

protected HttpResponse get(ApiPath path,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                    throws EnterprisePluginException

Throws:

EnterprisePluginException

getJson

protected <T> T getJson(ApiPath path,
 Class<T> valueType,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                 throws EnterprisePluginException

Throws:

EnterprisePluginException

getJson

protected <T> T getJson(ApiPath path,
 Class<T> valueType)
                 throws EnterprisePluginException

Throws:

EnterprisePluginException

getJson

protected <T> T getJson(ApiPath path,
 com.fasterxml.jackson.core.type.TypeReference<T> valueTypeRef,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                 throws EnterprisePluginException

Throws:

EnterprisePluginException

getJson

protected <T> T getJson(ApiPath path,
 com.fasterxml.jackson.core.type.TypeReference<T> valueTypeRef)
                 throws EnterprisePluginException

Throws:

EnterprisePluginException

post

protected HttpResponse post(ApiPath path,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpURLConnection,EnterprisePluginException> beforeRequest,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                     throws EnterprisePluginException

Throws:

EnterprisePluginException

postJson

protected HttpResponse postJson(ApiPath path,
 Object body,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                         throws EnterprisePluginException

Throws:

EnterprisePluginException

postJson

protected HttpResponse postJson(ApiPath path,
 Object body)
                         throws EnterprisePluginException

Throws:

EnterprisePluginException

postJson

protected <T> T postJson(ApiPath path,
 Object body,
 Class<T> valueType)
                  throws EnterprisePluginException

Throws:

EnterprisePluginException

put

protected HttpResponse put(ApiPath path,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpURLConnection,EnterprisePluginException> beforeRequest,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                    throws EnterprisePluginException

Throws:

EnterprisePluginException

putJson

protected HttpResponse putJson(ApiPath path,
 Object body,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                        throws EnterprisePluginException

Throws:

EnterprisePluginException

putJson

protected HttpResponse putJson(ApiPath path,
 Object body)
                        throws EnterprisePluginException

Throws:

EnterprisePluginException

putJson

protected <T> T putJson(ApiPath path,
 Object body,
 Class<T> valueType,
 LambdaExceptionUtil.ConsumerWithExceptions<HttpResponse,EnterprisePluginException> validateResponse)
                 throws EnterprisePluginException

Throws:

EnterprisePluginException

putJson

protected <T> T putJson(ApiPath path,
 Object body,
 Class<T> valueType)
                 throws EnterprisePluginException

Throws:

EnterprisePluginException