GoodMem
ReferenceClient SDKsJavaScript SDKRequests

PingStreamRequest

PingStreamRequest documentation for JavaScript SDK

Properties

NameTypeDescriptionNotes
targetIdStringTarget resource ID (UUID)
targetTypeHintPingTargetType[optional]
countNumberNumber of probes to run (0 uses server default)[optional]
intervalMsNumberDelay between probes in milliseconds (0 uses server default)[optional]
timeoutMsNumberPer-probe timeout in milliseconds (0 uses server default)[optional]
payloadTypePingPayloadType[optional]
payloadStringExplicit UTF-8 payload to send with each probe (mutually exclusive with payloadSizeBytes)[optional]
payloadSizeBytesNumberSynthetic payload size in bytes (mutually exclusive with payload)[optional]
maxInFlightNumberMaximum concurrent probes (defaults to 1)[optional]
jitterBooleanAdd jitter to probe scheduling[optional]
labels{String: String}Optional labels to attach to the ping session[optional]

On this page