Class SyntheticsBrowserTest

Object containing details about a Synthetic browser test.

Hierarchy

  • SyntheticsBrowserTest

Constructors

constructor

Properties

additionalProperties? config locations message monitorId? name options publicId? status? steps? tags? type

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

config

config: SyntheticsBrowserTestConfig

Configuration object for a Synthetic browser test.

locations

locations: string[]

Array of locations used to run the test.

message

message: string

Notification message associated with the test. Message can either be text or an empty string.

Optional monitorId

monitorId?: number

The associated monitor ID.

name

name: string

Name of the test.

options

options: SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Optional publicId

publicId?: string

The public ID of the test.

Optional status

status?: SyntheticsTestPauseStatus

Define whether you want to start (live) or pause (paused) a Synthetic test.

Optional steps

steps?: SyntheticsStep[]

Array of steps for the test.

Optional tags

tags?: string[]

Array of tags attached to the test.

type

type: SyntheticsBrowserTestType

Type of the Synthetic test, browser.

Settings

Member Visibility

Theme

Generated using TypeDoc