publish_entity

Part of Reusable workflows in the Python API reference.

Related guidance: shipped-tooling.

Runnable examples: publish_entity.py.

from picogrid_ecn_client.workflows import publish_entity

Construct and publish one typed public entity.

async def publish_entity(
    client: ECNClient,
    *,
    entity_id: UUID,
    category: EntityCategory,
    entity_type: str,
    name: str | None = None,
    display_name: str | None = None,
    recorded_at: datetime | None = None,
) -> PublishEntityResult

Parameters

Name	Type	Default	Description
client	ECNClient	—	Configured SDK client used for publication.
entity_id	UUID	—	Canonical identity of the entity to publish.
category	EntityCategory	—	Public category assigned to the entity.
entity_type	str	—	Deployment-defined type assigned to the entity.
name	str | None	None	Optional entity name.
display_name	str | None	None	Optional operator-facing display label.
recorded_at	datetime | None	None	Optional observation time; current UTC time when omitted.

Returns

Type	Description
PublishEntityResult	The published entity and its broker acknowledgement.

Raises

Exception	Description
ECNClientError	If validation, connection, or publication fails.

Source · workflows/publish.py