Enum BuildIdTaskReachability

Namespace

Temporalio.Api.Enums.V1

Assembly

Temporalio.dll

Specifies which category of tasks may reach a versioned worker of a certain Build ID.

Task Reachability is eventually consistent; there may be a delay until it converges to the most accurate value but it is designed in a way to take the more conservative side until it converges. For example REACHABLE is more conservative than CLOSED_WORKFLOWS_ONLY.

Note: future activities who inherit their workflow's Build ID but not its Task Queue will not be accounted for reachability as server cannot know if they'll happen as they do not use assignment rules of their Task Queue. Same goes for Child Workflows or Continue-As-New Workflows who inherit the parent/previous workflow's Build ID but not its Task Queue. In those cases, make sure to query reachability for the parent/previous workflow's Task Queue as well.

public enum BuildIdTaskReachability

Fields

[OriginalName("BUILD_ID_TASK_REACHABILITY_CLOSED_WORKFLOWS_ONLY")] ClosedWorkflowsOnly = 2

Build ID does not have open workflows and is not reachable by new workflows, but MAY have closed workflows within the namespace retention period. Not applicable to activity-only task queues.

[OriginalName("BUILD_ID_TASK_REACHABILITY_REACHABLE")] Reachable = 1

Build ID may be used by new workflows or activities (base on versioning rules), or there MAY be open workflows or backlogged activities assigned to it.

[OriginalName("BUILD_ID_TASK_REACHABILITY_UNREACHABLE")] Unreachable = 3

Build ID is not used for new executions, nor it has been used by any existing execution within the retention period.

[OriginalName("BUILD_ID_TASK_REACHABILITY_UNSPECIFIED")] Unspecified = 0

Task reachability is not reported