Class SyntheticsNetworkTestRequest

Object describing the request for a Network Path test.

Hierarchy

  • SyntheticsNetworkTestRequest

Constructors

constructor

Properties

additionalProperties? destinationService? e2eQueries host maxTtl port? sourceService? tcpMethod? timeout? tracerouteQueries

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 destinationService

destinationService?: string

An optional label displayed for the destination host in the Network Path visualization.

e2eQueries

e2eQueries: number

The number of packets sent to probe the destination to measure packet loss, latency and jitter.

host

host: string

Host name to query.

maxTtl

maxTtl: number

The maximum time-to-live (max number of hops) used in outgoing probe packets.

Optional port

port?: number

For TCP or UDP tests, the port to use when performing the test. If not set on a UDP test, a random port is assigned, which may affect the results.

Optional sourceService

sourceService?: string

An optional label displayed for the source host in the Network Path visualization.

Optional tcpMethod

tcpMethod?: SyntheticsNetworkTestRequestTCPMethod

For TCP tests, the TCP traceroute strategy.

Optional timeout

timeout?: number

Timeout in seconds.

tracerouteQueries

tracerouteQueries: number

The number of traceroute path tracings.

Settings

Member Visibility

Theme

Generated using TypeDoc