LoadTestConfiguration Class

Package:
com.azure.developer.loadtesting.models
Maven Artifact:
com.azure:azure-developer-loadtesting:1.2.0-beta.1
  • java.lang.Object
    • com.azure.developer.loadtesting.models.LoadTestConfiguration

Implements

JsonSerializable<LoadTestConfiguration>

public final class LoadTestConfiguration
implements JsonSerializable<LoadTestConfiguration>

Configurations for the load test.

Constructor Summary

Constructor Description
LoadTestConfiguration()

Creates an instance of LoadTestConfiguration class.

Method Summary

Modifier and Type Method and Description
static LoadTestConfiguration fromJson(JsonReader jsonReader)

Reads an instance of LoadTestConfiguration from the JsonReader.
Integer getEngineInstances()

Get the engineInstances property: The number of engine instances to execute load test.
OptionalLoadTestConfiguration getOptionalLoadTestConfiguration()

Get the optionalLoadTestConfiguration property: Configuration for quick load test.
List<RegionalConfiguration> getRegionalLoadTestConfiguration()

Get the regionalLoadTestConfiguration property: Region distribution configuration for the load test.
Boolean isQuickStartTest()

Get the quickStartTest property: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.
Boolean isSplitAllCsvs()

Get the splitAllCsvs property: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances.
LoadTestConfiguration setEngineInstances(Integer engineInstances)

Set the engineInstances property: The number of engine instances to execute load test.
LoadTestConfiguration setOptionalLoadTestConfiguration(OptionalLoadTestConfiguration optionalLoadTestConfiguration)

Set the optionalLoadTestConfiguration property: Configuration for quick load test.
LoadTestConfiguration setQuickStartTest(Boolean quickStartTest)

Set the quickStartTest property: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.
LoadTestConfiguration setRegionalLoadTestConfiguration(List<RegionalConfiguration> regionalLoadTestConfiguration)

Set the regionalLoadTestConfiguration property: Region distribution configuration for the load test.
LoadTestConfiguration setSplitAllCsvs(Boolean splitAllCsvs)

Set the splitAllCsvs property: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

LoadTestConfiguration

public LoadTestConfiguration()

Creates an instance of LoadTestConfiguration class.

Method Details

fromJson

public static LoadTestConfiguration fromJson(JsonReader jsonReader)

Reads an instance of LoadTestConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of LoadTestConfiguration if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

 - If an error occurs while reading the LoadTestConfiguration.

getEngineInstances

public Integer getEngineInstances()

Get the engineInstances property: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test.

Returns:

the engineInstances value.

getOptionalLoadTestConfiguration

public OptionalLoadTestConfiguration getOptionalLoadTestConfiguration()

Get the optionalLoadTestConfiguration property: Configuration for quick load test.

Returns:

the optionalLoadTestConfiguration value.

getRegionalLoadTestConfiguration

public List<RegionalConfiguration> getRegionalLoadTestConfiguration()

Get the regionalLoadTestConfiguration property: Region distribution configuration for the load test.

Returns:

the regionalLoadTestConfiguration value.

isQuickStartTest

public Boolean isQuickStartTest()

Get the quickStartTest property: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.

Returns:

the quickStartTest value.

isSplitAllCsvs

public Boolean isSplitAllCsvs()

Get the splitAllCsvs property: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly.

Returns:

the splitAllCsvs value.

setEngineInstances

public LoadTestConfiguration setEngineInstances(Integer engineInstances)

Set the engineInstances property: The number of engine instances to execute load test. Supported values are in range of 1-400. Required for creating a new test.

Parameters:

engineInstances - the engineInstances value to set.

Returns:

the LoadTestConfiguration object itself.

setOptionalLoadTestConfiguration

public LoadTestConfiguration setOptionalLoadTestConfiguration(OptionalLoadTestConfiguration optionalLoadTestConfiguration)

Set the optionalLoadTestConfiguration property: Configuration for quick load test.

Parameters:

optionalLoadTestConfiguration - the optionalLoadTestConfiguration value to set.

Returns:

the LoadTestConfiguration object itself.

setQuickStartTest

public LoadTestConfiguration setQuickStartTest(Boolean quickStartTest)

Set the quickStartTest property: If true, optionalLoadTestConfig is required and JMX script for the load test is not required to upload.

Parameters:

quickStartTest - the quickStartTest value to set.

Returns:

the LoadTestConfiguration object itself.

setRegionalLoadTestConfiguration

public LoadTestConfiguration setRegionalLoadTestConfiguration(List<RegionalConfiguration> regionalLoadTestConfiguration)

Set the regionalLoadTestConfiguration property: Region distribution configuration for the load test.

Parameters:

regionalLoadTestConfiguration - the regionalLoadTestConfiguration value to set.

Returns:

the LoadTestConfiguration object itself.

setSplitAllCsvs

public LoadTestConfiguration setSplitAllCsvs(Boolean splitAllCsvs)

Set the splitAllCsvs property: If false, Azure Load Testing copies and processes your input files unmodified across all test engine instances. If true, Azure Load Testing splits the CSV input data evenly across all engine instances. If you provide multiple CSV files, each file will be split evenly.

Parameters:

splitAllCsvs - the splitAllCsvs value to set.

Returns:

the LoadTestConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to