SubscriptionProbe

Part of Diagnostics & preflight in the Python API reference.

Related guidance: getting-started/preflight, how-to/troubleshooting.

Runnable examples: preflight.py.

from picogrid_ecn_client import SubscriptionProbe

Describe one caller-requested MQTT subscription authorization probe.

SubscriptionProbe(
    *,
    kind: SubscriptionProbeKind,
    integration: str,
    wire_format: WireFormat = WireFormat.JSON,
    entity_id: UUID | None = None,
    category: EntityCategory | None = None,
)

Source · models/diagnostics.py

Fields

Name	Type	Required	Default	Constraints	Description
kind	SubscriptionProbeKind	yes	—	—	Topic family to probe: entity or geolocation.
integration	str	yes	—	min_length=2, max_length=128, pattern='^[A-Za-z0-9][A-Za-z0-9_-]{0,126}[A-Za-z0-9]$'	Exact integration topic segment included in the bounded probe.
wire_format	WireFormat	no	WireFormat.JSON	—	Payload encoding whose topic shape is probed; defaults to JSON.
entity_id	UUID | None	no	None	—	Exact entity UUID; optional for JSON entity, required for JSON location, and forbidden for protobuf entity or location probes.
category	EntityCategory | None	no	None	—	Publishable entity category; required for entity probes and forbidden for location probes.