RegionalConfiguration Class

  • java.lang.Object
    • com.azure.developer.loadtesting.models.RegionalConfiguration

Implements

public final class RegionalConfiguration
implements JsonSerializable<RegionalConfiguration>

Region distribution configuration for the load test.

Constructor Summary

Constructor Description
RegionalConfiguration()

Creates an instance of RegionalConfiguration class.

Method Summary

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

Reads an instance of RegionalConfiguration from the JsonReader.

int getEngineInstances()

Get the engineInstances property: The number of engine instances to execute load test in specified region.

String getRegion()

Get the region property: Azure region name.

RegionalConfiguration setEngineInstances(int engineInstances)

Set the engineInstances property: The number of engine instances to execute load test in specified region.

RegionalConfiguration setRegion(String region)

Set the region property: Azure region name.

JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

Constructor Details

RegionalConfiguration

public RegionalConfiguration()

Creates an instance of RegionalConfiguration class.

Method Details

fromJson

public static RegionalConfiguration fromJson(JsonReader jsonReader)

Reads an instance of RegionalConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of RegionalConfiguration 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 RegionalConfiguration.

getEngineInstances

public int getEngineInstances()

Get the engineInstances property: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400.

Returns:

the engineInstances value.

getRegion

public String getRegion()

Get the region property: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command.

Returns:

the region value.

setEngineInstances

public RegionalConfiguration setEngineInstances(int engineInstances)

Set the engineInstances property: The number of engine instances to execute load test in specified region. Supported values are in range of 1-400.

Required when create the resource.

Parameters:

engineInstances - the engineInstances value to set.

Returns:

the RegionalConfiguration object itself.

setRegion

public RegionalConfiguration setRegion(String region)

Set the region property: Azure region name. The region name should of format accepted by ARM, and should be a region supported by Azure Load Testing. For example, East US should be passed as "eastus". The region name must match one of the strings in the "Name" column returned from running the "az account list-locations -o table" Azure CLI command.

Required when create the resource.

Parameters:

region - the region value to set.

Returns:

the RegionalConfiguration object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to