Class SyntheticsAPISubtestStep

The subtest step used in a Synthetics multi-step API test.

Hierarchy

  • SyntheticsAPISubtestStep

Constructors

constructor

Properties

additionalProperties? allowFailure? alwaysExecute? exitIfSucceed? extractedValuesFromScript? id? isCritical? name retry? subtestPublicId 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.

Optional alwaysExecute

alwaysExecute?: boolean

A boolean set to always execute this step even if the previous step failed or was skipped.

Optional exitIfSucceed

exitIfSucceed?: boolean

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

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.

Optional retry

retry?: SyntheticsTestOptionsRetry

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

subtestPublicId

subtestPublicId: string

Public ID of the test to be played as part of a playSubTest step type.

subtype

subtype: SyntheticsAPISubtestStepSubtype

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

Settings

Member Visibility

Theme

Generated using TypeDoc