Class SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Hierarchy

  • SyntheticsTestOptions

Constructors

constructor

Properties

additionalProperties? minFailureDuration? minLocationFailed? monitorName? monitorOptions? monitorPriority? restrictedRoles? retry? scheduling? tickEvery?

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 minFailureDuration

minFailureDuration?: number

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

Optional minLocationFailed

minLocationFailed?: number

Minimum number of locations in failure required to trigger an alert.

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?: v2.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 restrictedRoles

restrictedRoles?: string[]

A list of role identifiers that can be pulled from the Roles API, for restricting read and write access. This field is deprecated. Use the restriction policies API to manage permissions.

Optional retry

retry?: v2.SyntheticsTestOptionsRetry

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

Optional scheduling

scheduling?: v2.SyntheticsTestOptionsScheduling

Object containing timeframes and timezone used for advanced scheduling.

Optional tickEvery

tickEvery?: number

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

Settings

Member Visibility

Theme

Generated using TypeDoc