Class Priority

Namespace

Temporalio.Common

Assembly

Temporalio.dll

Priority contains metadata that controls relative ordering of task processing when tasks are backlogged in a queue. Initially, Priority will be used in activity and workflow task queues, which are typically where backlogs exist. Priority is (for now) attached to workflows and activities. Activities and child workflows inherit Priority from the workflow that created them, but may override fields when they are started or modified. For each field of a Priority on an activity/workflow, not present or equal to zero/empty string means to inherit the value from the calling workflow, or if there is no calling workflow, then use the default (documented on the field).

The overall semantics of Priority are:

1. First, consider "priority_key": lower number goes first. (more will be added here later).

public sealed record Priority : IEquatable<Priority>

Inheritance

object

Priority

Implements

IEquatable<Priority>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Priority(int?)

Initializes a new instance of the Priority class.

public Priority(int? priorityKey = null)

Parameters

priorityKey int?

The priority key.

Properties

Default

Gets the default Priority instance.

public static Priority Default { get; }

Property Value

Priority

PriorityKey

Gets the priority key, which is a positive integer from 1 to n, where smaller integers correspond to higher priorities (tasks run sooner). In general, tasks in a queue should be processed in close to priority order, although small deviations are possible. The maximum priority value (minimum priority) is determined by server configuration, and defaults to 5.

The default priority is (min+max)/2. With the default max of 5 and min of 1, that comes out to 3.

public int? PriorityKey { get; init; }

Property Value

int?