Class SyntheticsNetworkTest

Object containing details about a Network Path test.

Hierarchy

  • SyntheticsNetworkTest

Constructors

constructor

Properties

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

config

config: SyntheticsNetworkTestConfig

Configuration object for a Network Path test.

locations

locations: string[]

Array of locations used to run the test. Network Path tests can be run from managed locations to test public endpoints, or from a Datadog Agent to test private environments.

message

message: string

Notification message associated with the test.

Optional monitorId

monitorId?: number

The associated monitor ID.

name

name: string

Name of the test.

options

options: v2.SyntheticsTestOptions

Object describing the extra options for a Synthetic test.

Optional publicId

publicId?: string

The public ID for the test.

Optional status

status?: v2.SyntheticsTestPauseStatus

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

Optional subtype

subtype?: SyntheticsNetworkTestSubType

Subtype of the Synthetic Network Path test: tcp, udp, or icmp.

Optional tags

tags?: string[]

Array of tags attached to the test.

type

type: SyntheticsNetworkTestType

Type of the Synthetic test, network.

Settings

Member Visibility

Theme

Generated using TypeDoc