Class SyntheticsMobileTestOptions

Object describing the extra options for a Synthetic test.

Hierarchy

  • SyntheticsMobileTestOptions

Constructors

constructor

Properties

additionalProperties? allowApplicationCrash? bindings? ci? defaultStepTimeout? deviceIds disableAutoAcceptAlert? minFailureDuration? mobileApplication monitorName? monitorOptions? monitorPriority? noScreenshot? restrictedRoles? retry? scheduling? tickEvery verbosity?

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 allowApplicationCrash

allowApplicationCrash?: boolean

A boolean to set if an application crash would mark the test as failed.

Optional bindings

bindings?: SyntheticsTestRestrictionPolicyBinding[]

Array of bindings used for the mobile test.

Optional ci

ci?: SyntheticsTestCiOptions

CI/CD options for a Synthetic test.

Optional defaultStepTimeout

defaultStepTimeout?: number

The default timeout for steps in the test (in seconds).

deviceIds

deviceIds: string[]

For mobile test, array with the different device IDs used to run the test.

Optional disableAutoAcceptAlert

disableAutoAcceptAlert?: boolean

A boolean to disable auto accepting alerts.

Optional minFailureDuration

minFailureDuration?: number

Minimum amount of time in failure required to trigger an alert.

mobileApplication

mobileApplication: SyntheticsMobileTestsMobileApplication

Mobile application for mobile synthetics test.

Optional monitorName

monitorName?: string

The monitor name is used for the alert title as well as for all monitor dashboard widgets and SLOs.

Optional monitorOptions

monitorOptions?: SyntheticsTestOptionsMonitorOptions

Object containing the options for a Synthetic test as a monitor (for example, renotification).

Optional monitorPriority

monitorPriority?: number

Integer from 1 (high) to 5 (low) indicating alert severity.

Optional noScreenshot

noScreenshot?: boolean

A boolean set to not take a screenshot for the step.

Optional restrictedRoles

restrictedRoles?: string[]

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access.

Optional retry

retry?: SyntheticsTestOptionsRetry

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

Optional scheduling

scheduling?: SyntheticsTestOptionsScheduling

Object containing timeframes and timezone used for advanced scheduling.

tickEvery

tickEvery: number

The frequency at which to run the Synthetic test (in seconds).

Optional verbosity

verbosity?: number

The level of verbosity for the mobile test. This field can not be set by a user.

Settings

Member Visibility

Theme

Generated using TypeDoc