Class SyntheticsTestDetails

Object containing details about your Synthetic test.

Hierarchy

  • SyntheticsTestDetails

Constructors

constructor

Properties

additionalProperties? config? creator? locations? message? monitorId? name? options? publicId? status? steps? subtype? 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

Optional config

config?: SyntheticsTestConfig

Configuration object for a Synthetic test.

Optional creator

creator?: v1.Creator

Object describing the creator of the shared element.

Optional locations

locations?: string[]

Array of locations used to run the test.

Optional message

message?: string

Notification message associated with the test.

Optional monitorId

monitorId?: number

The associated monitor ID.

Optional name

name?: string

Name of the test.

Optional options

options?: SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Optional publicId

publicId?: string

The test public ID.

Optional status

status?: SyntheticsTestPauseStatus

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

Optional steps

steps?: SyntheticsStep[]

For browser test, the steps of the test.

Optional subtype

subtype?: SyntheticsTestDetailsSubType

The subtype of the Synthetic API test, http, ssl, tcp, dns, icmp, udp, websocket, grpc or multi.

Optional tags

tags?: string[]

Array of tags attached to the test.

Optional type

type?: SyntheticsTestDetailsType

Type of the Synthetic test, either api or browser.

Settings

Member Visibility

Theme

Generated using TypeDoc