Class: Temporalio::Priority

Inherits:

Data

• Object
• Data
• Temporalio::Priority

Defined in:

lib/temporalio/priority.rb,
lib/temporalio/priority.rb

Overview

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).

Instance Attribute Summary

• #fairness_key ⇒ String^?

  FairnessKey is a short string that’s used as a key for a fairness balancing mechanism.

• #fairness_weight ⇒ Float^?

  Weight for a task can come from multiple sources for flexibility.

• #priority_key ⇒ Integer^?

  The priority key, which is a positive integer from 1 to n, where smaller integers correspond to higher priorities (tasks run sooner).

Class Method Summary

• .default ⇒ Priority

  The default priority instance.

Instance Method Summary

• #empty? ⇒ Boolean

  True if this priority is empty/default.

• #initialize(priority_key: nil, fairness_key: nil, fairness_weight: nil) ⇒ Priority constructor

  Initialize a new Priority instance.

Constructor Details

#initialize(priority_key: nil, fairness_key: nil, fairness_weight: nil) ⇒ Priority

Initialize a new Priority instance.

# File 'lib/temporalio/priority.rb', line 80

def initialize(priority_key: nil, fairness_key: nil, fairness_weight: nil)
  super
end

Instance Attribute Details

#fairness_key ⇒ String^?

# File 'lib/temporalio/priority.rb', line 56

def fairness_key
  @fairness_key
end

#fairness_weight ⇒ Float^?

# File 'lib/temporalio/priority.rb', line 56

def fairness_weight
  @fairness_weight
end

#priority_key ⇒ Integer^?

# File 'lib/temporalio/priority.rb', line 56

def priority_key
  @priority_key
end

Class Method Details

.default ⇒ Priority

The default priority instance.

# File 'lib/temporalio/priority.rb', line 71

def self.default
  @default ||= new(priority_key: nil, fairness_key: nil, fairness_weight: nil)
end

Instance Method Details

#empty? ⇒ Boolean

# File 'lib/temporalio/priority.rb', line 96

def empty?
  priority_key.nil? && fairness_key.nil? && fairness_weight.nil?
end