gRPCanduril.taskmanager.v1TaskManagerAPI

StreamTasks

Establishes a server streaming connection that delivers task updates in real-time.

The stream delivers all existing non-terminal tasks when first connected, followed by real-time updates for task creation and status changes. Additionally, heartbeat messages are sent periodically to maintain the connection.

The stream delivers two types of responses:

  • Heartbeat: A periodic message to maintain connection health
  • TaskEvent: Contains a task and an event type indicating whether the task was created, updated, or was preexisting when the stream was established

Filtering options allow narrowing the stream to specific task types, statuses, assignees, parent tasks, or tasks updated after a certain time.

StreamTasksRequest

Request
This endpoint expects an object.
task_typeobject or string
rate_limitobject
Rate limit configuration for task update events.
viewslist of enums

Optional additional views of a Task. If not set, defaults to TASK_VIEW_MANAGER.

Allowed values:
heartbeat_interval_msuint

The time interval, in milliseconds, that determines the frequency at which to send heartbeat events. Defaults to 30000 (30 seconds).

exclude_preexisting_tasksboolean
Optional flag to only include tasks created or updated after the stream is initiated, and not any previous preexisting tasks. If unset or false, the stream will include any new tasks and task updates, as well as all preexisting tasks.
update_start_timeobject
If provided, returns tasks which have been updated since the given time.
parent_task_idstring

A filter for tasks with a specific parent task ID. Note: This filter is mutually exclusive with all other filter fields.

assigneeobject
A filter for tasks assigned to a specific principal.
status_filterobject
Filters on provided status types in the filter.

StreamTasksResponse

Stream response
This endpoint returns an object.
task_eventobject
Task event associated with the streaming request.
heartbeatobject
Heartbeat message signaling liveliness of the stream.