Class: Temporalio::Client::Schedule::Spec::Interval

Inherits:

Data

• Object
• Data
• Temporalio::Client::Schedule::Spec::Interval

Defined in:

lib/temporalio/client/schedule.rb,
lib/temporalio/client/schedule.rb

Overview

Specification for scheduling on an interval.

Matches times expressed as epoch + (n * every) + offset.

Instance Attribute Summary

• #every ⇒ Float

  Period to repeat the interval.

• #offset ⇒ Float^?

  Fixed offset added to each interval period.

Instance Method Summary

• #initialize(every:, offset: nil) ⇒ Interval constructor

  Create an interval spec.

Constructor Details

#initialize(every:, offset: nil) ⇒ Interval

Create an interval spec.

Parameters:

• every (Float) —

  Period to repeat the interval.

• offset (Float, nil) (defaults to: nil) —

  Fixed offset added to each interval period.

# File 'lib/temporalio/client/schedule.rb', line 650

def initialize(every:, offset: nil)
  super
end

Instance Attribute Details

#every ⇒ Float

Returns Period to repeat the interval.

Returns:

• (Float) —

  Period to repeat the interval.

# File 'lib/temporalio/client/schedule.rb', line 637

def every
  @every
end

#offset ⇒ Float^?

Returns Fixed offset added to each interval period.

Returns:

• (Float, nil) —

  Fixed offset added to each interval period.

# File 'lib/temporalio/client/schedule.rb', line 637

def offset
  @offset
end