PassFailMetric Class
- java.
lang. Object - com.
azure. developer. loadtesting. models. PassFailMetric
- com.
Implements
public final class PassFailMetric
implements JsonSerializable<PassFailMetric>
Pass fail metric.
Constructor Summary
| Constructor | Description |
|---|---|
| PassFailMetric() |
Creates an instance of Pass |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Pass |
fromJson(JsonReader jsonReader)
Reads an instance of Pass |
|
Pass |
getAction()
Get the action property: Action taken after the threshold is met. |
| Double |
getActualValue()
Get the actual |
|
Pass |
getAggregate()
Get the aggregate property: The aggregation function to be applied on the client metric. |
|
Pf |
getClientMetric()
Get the client |
| String |
getCondition()
Get the condition property: The comparison operator. |
| String |
getRequestName()
Get the request |
|
Pass |
getResult()
Get the result property: Outcome of the test run. |
| Double |
getValue()
Get the value property: The value to compare with the client metric. |
|
Pass |
setAction(PassFailAction action)
Set the action property: Action taken after the threshold is met. |
|
Pass |
setAggregate(PassFailAggregationFunction aggregate)
Set the aggregate property: The aggregation function to be applied on the client metric. |
|
Pass |
setClientMetric(PfMetrics clientMetric)
Set the client |
|
Pass |
setCondition(String condition)
Set the condition property: The comparison operator. |
|
Pass |
setRequestName(String requestName)
Set the request |
|
Pass |
setValue(Double value)
Set the value property: The value to compare with the client metric. |
|
Json |
toJson(JsonWriter jsonWriter) |
Methods inherited from java.lang.Object
Constructor Details
PassFailMetric
public PassFailMetric()
Creates an instance of PassFailMetric class.
Method Details
fromJson
public static PassFailMetric fromJson(JsonReader jsonReader)
Reads an instance of PassFailMetric from the JsonReader.
Parameters:
Returns:
Throws:
getAction
public PassFailAction getAction()
Get the action property: Action taken after the threshold is met. Default is ‘continue’.
Returns:
getActualValue
public Double getActualValue()
Get the actualValue property: The actual value of the client metric for the test run.
Returns:
getAggregate
public PassFailAggregationFunction getAggregate()
Get the aggregate property: The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests.
Returns:
getClientMetric
public PfMetrics getClientMetric()
Get the clientMetric property: The client metric on which the criteria should be applied.
Returns:
getCondition
public String getCondition()
Get the condition property: The comparison operator. Supported types ‘>’, ‘<’.
Returns:
getRequestName
public String getRequestName()
Get the requestName property: Request name for which the Pass fail criteria has to be applied.
Returns:
getResult
public PassFailResult getResult()
Get the result property: Outcome of the test run.
Returns:
getValue
public Double getValue()
Get the value property: The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.
Returns:
setAction
public PassFailMetric setAction(PassFailAction action)
Set the action property: Action taken after the threshold is met. Default is ‘continue’.
Parameters:
Returns:
setAggregate
public PassFailMetric setAggregate(PassFailAggregationFunction aggregate)
Set the aggregate property: The aggregation function to be applied on the client metric. Allowed functions - ‘percentage’ - for error metric , ‘avg’, percentiles like ‘p50’, ‘p90’, & so on, ‘min’, ‘max’ - for response_time_ms and latency metric, ‘avg’ - for requests_per_sec, ‘count’ - for requests.
Parameters:
Returns:
setClientMetric
public PassFailMetric setClientMetric(PfMetrics clientMetric)
Set the clientMetric property: The client metric on which the criteria should be applied.
Parameters:
Returns:
setCondition
public PassFailMetric setCondition(String condition)
Set the condition property: The comparison operator. Supported types ‘>’, ‘<’.
Parameters:
Returns:
setRequestName
public PassFailMetric setRequestName(String requestName)
Set the requestName property: Request name for which the Pass fail criteria has to be applied.
Parameters:
Returns:
setValue
public PassFailMetric setValue(Double value)
Set the value property: The value to compare with the client metric. Allowed values - ‘error : [0.0 , 100.0] unit- % ’, response_time_ms and latency : any integer value unit- ms.
Parameters:
Returns:
