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

Inherits:

Data

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

Defined in:

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

Overview

Specification of the times scheduled actions may occur.

The times are the union of #calendars, #intervals, and #cron_expressions excluding anything in #skip.

Defined Under Namespace

Classes: Calendar, Interval

Instance Attribute Summary

• #calendars ⇒ Array<Calendar>

  Calendar-based specification of times.

• #cron_expressions ⇒ Array<String>

  Cron-based specification of times.

• #end_at ⇒ Time^?

  Time after which any matching times will be skipped.

• #intervals ⇒ Array<Interval>

  Interval-based specification of times.

• #jitter ⇒ Float^?

  Jitter to apply each action.

• #skip ⇒ Array<Calendar>

  Set of matching calendar times that will be skipped.

• #start_at ⇒ Time^?

  Time before which any matching times will be skipped.

• #time_zone_name ⇒ String^?

  IANA time zone name, for example US/Central.

Instance Method Summary

• #initialize(calendars: [], intervals: [], cron_expressions: [], skip: [], start_at: nil, end_at: nil, jitter: nil, time_zone_name: nil) ⇒ Spec constructor

  Create a spec.

Constructor Details

#initialize(calendars: [], intervals: [], cron_expressions: [], skip: [], start_at: nil, end_at: nil, jitter: nil, time_zone_name: nil) ⇒ Spec

Create a spec.

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

def initialize(
  calendars: [],
  intervals: [],
  cron_expressions: [],
  skip: [],
  start_at: nil,
  end_at: nil,
  jitter: nil,
  time_zone_name: nil
)
  super
end

Instance Attribute Details

#calendars ⇒ Array<Calendar>

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

def calendars
  @calendars
end

#cron_expressions ⇒ Array<String>

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

def cron_expressions
  @cron_expressions
end

#end_at ⇒ Time^?

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

def end_at
  @end_at
end

#intervals ⇒ Array<Interval>

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

def intervals
  @intervals
end

#jitter ⇒ Float^?

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

def jitter
  @jitter
end

#skip ⇒ Array<Calendar>

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

def skip
  @skip
end

#start_at ⇒ Time^?

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

def start_at
  @start_at
end

#time_zone_name ⇒ String^?

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

def time_zone_name
  @time_zone_name
end