GoodMemGoodMem
ReferenceSdkRustTypes

PingStreamRequest

Rust struct goodmem::models::PingStreamRequest: declaration, fields or variants, and implementations.

All types

Struct PingStreamRequest

goodmem::models::PingStreamRequest

Request payload for a streaming ping session

pub struct PingStreamRequest {
    pub target_id: String,
    pub target_type_hint: Option<PingTargetType>,
    pub count: Option<i32>,
    pub interval_ms: Option<i32>,
    pub timeout_ms: Option<i32>,
    pub payload_type: Option<PingPayloadType>,
    pub payload: Option<String>,
    pub payload_size_bytes: Option<i32>,
    pub max_in_flight: Option<i32>,
    pub jitter: Option<bool>,
    pub labels: Option<BTreeMap<String, String>>,
}

Referenced types: PingPayloadType, PingTargetType.

Fields

target_id

pub target_id: String

Target resource ID (UUID) Wire name: targetId.

target_type_hint

pub target_type_hint: Option<PingTargetType>

Optional hint for the target resource type Wire name: targetTypeHint.

count

pub count: Option<i32>

Number of probes to run (0 uses server default) Wire name: count.

interval_ms

pub interval_ms: Option<i32>

Delay between probes in milliseconds (0 uses server default) Wire name: intervalMs.

timeout_ms

pub timeout_ms: Option<i32>

Per-probe timeout in milliseconds (0 uses server default) Wire name: timeoutMs.

payload_type

pub payload_type: Option<PingPayloadType>

Desired payload type (defaults to provider-specific value) Wire name: payloadType.

payload

pub payload: Option<String>

Explicit UTF-8 payload to send with each probe (mutually exclusive with payloadSizeBytes) Wire name: payload.

payload_size_bytes

pub payload_size_bytes: Option<i32>

Synthetic payload size in bytes (mutually exclusive with payload) Wire name: payloadSizeBytes.

max_in_flight

pub max_in_flight: Option<i32>

Maximum concurrent probes (defaults to 1) Wire name: maxInFlight.

jitter

pub jitter: Option<bool>

Add jitter to probe scheduling Wire name: jitter.

labels

pub labels: Option<BTreeMap<String, String>>

Optional labels to attach to the ping session Wire name: labels.

Implementations

validate

pub fn validate(&self) -> crate::Result<()>

Validate the request before sending, without making an HTTP call.

Trait implementations

  • Clone (derived)
  • Default (derived)
  • PartialEq (derived)
  • Serialize (derived)
  • impl<'de> Deserialize<'de> for PingStreamRequest
  • impl std::fmt::Debug for PingStreamRequest

On this page