gRPCanduril.entitymanager.v1EntityManagerAPI

StreamEntityComponents

Returns a stream of entities with specified components populated.

StreamEntityComponentsRequest

Request
This endpoint expects an object.
components_to_includelist of strings

lower_snake_case component names to include in response events, e.g. location. Only included components will populate.

include_all_componentsboolean

Subscribe to all components. This should only be used in cases where you want all components. Setting both components_to_include and include_all_components is invalid and will be rejected.

filterobject
The root node of a statement filter "tree". If provided, only entities matching the filter criteria will be streamed. The filter is applied dynamically so if a new entity matches, it will be included, and if an entity updates to no longer match, it will be excluded.
rate_limitobject

Optional rate-limiting / down-sampling parameters, see RateLimit message for details.

heartbeat_period_millisuint

The period (in milliseconds) at which a Heartbeat message will be sent on the message stream. If this field is set to 0 then no Heartbeat messages are sent.

preexisting_onlyboolean

Subscribe to a finite stream of preexisting events which closes when there are no additional pre-existing events to process. Respects the filter specified on the StreamEntityComponentsRequest.

StreamEntityComponentsResponse

Stream Response
This endpoint returns an object.
entity_eventobject
Event representing some type of entity change.
heartbeatobject

A message that is periodically sent on the stream for keep-alive behaviour.