Class SyntheticsAPITestStep

The Test step used in a Synthetic multi-step API test.

Hierarchy

  • SyntheticsAPITestStep

Constructors

constructor

Properties

additionalProperties? allowFailure? assertions exitIfSucceed? extractedValues? extractedValuesFromScript? id? isCritical? name request retry? subtype

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional allowFailure

allowFailure?: boolean

Determines whether or not to continue with test if this step fails.

assertions

assertions: SyntheticsAssertion[]

Array of assertions used for the test.

Optional exitIfSucceed

exitIfSucceed?: boolean

Determines whether or not to exit the test if the step succeeds.

Optional extractedValues

extractedValues?: SyntheticsParsingOptions[]

Array of values to parse and save as variables from the response.

Optional extractedValuesFromScript

extractedValuesFromScript?: string

Generate variables using JavaScript.

Optional id

id?: string

ID of the step.

Optional isCritical

isCritical?: boolean

Determines whether or not to consider the entire test as failed if this step fails. Can be used only if allowFailure is true.

name

name: string

The name of the step.

request

request: SyntheticsTestRequest

Object describing the Synthetic test request.

Optional retry

retry?: SyntheticsTestOptionsRetry

Object describing the retry strategy to apply to a Synthetic test.

subtype

subtype: SyntheticsAPITestStepSubtype

The subtype of the Synthetic multi-step API test step.

Settings

Member Visibility

Theme

Generated using TypeDoc