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

Inherits:
Data
  • Object
show all
Defined in:
lib/temporalio/client/schedule.rb,
lib/temporalio/client/schedule.rb

Overview

Specification relative to calendar time when to run an action.

A timestamp matches if at least one range of each field matches except for year. If year is missing, that means all years match. For all fields besides year, at least one range must be present to match anything.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(second: [Range.new(0)], minute: [Range.new(0)], hour: [Range.new(0)], day_of_month: [Range.new(1, 31)], month: [Range.new(1, 12)], year: [], day_of_week: [Range.new(0, 6)], comment: nil) ⇒ Calendar

Create a calendar spec.

Parameters:

  • second (Array<Range>) (defaults to: [Range.new(0)]) —

    Second range to match, 0-59. Default matches 0.

  • minute (Array<Range>) (defaults to: [Range.new(0)]) —

    Minute range to match, 0-59. Default matches 0.

  • hour (Array<Range>) (defaults to: [Range.new(0)]) —

    Hour range to match, 0-23. Default matches 0.

  • day_of_month (Array<Range>) (defaults to: [Range.new(1, 31)]) —

    Day of month range to match, 1-31. Default matches all days.

  • month (Array<Range>) (defaults to: [Range.new(1, 12)]) —

    Month range to match, 1-12. Default matches all months.

  • year (Array<Range>) (defaults to: []) —

    Optional year range to match. Default of empty matches all years.

  • day_of_week (Array<Range>) (defaults to: [Range.new(0, 6)]) —

    Day of week range to match, 0-6, 0 is Sunday. Default matches all days.

  • comment (String, nil) (defaults to: nil) —

    Description of this schedule.



587
588
589
590
591
592
593
594
595
596
597
598
 
# File 'lib/temporalio/client/schedule.rb', line 587

def initialize(
  second: [Range.new(0)],
  minute: [Range.new(0)],
  hour: [Range.new(0)],
  day_of_month: [Range.new(1, 31)],
  month: [Range.new(1, 12)],
  year: [],
  day_of_week: [Range.new(0, 6)],
  comment: nil
)
  super
end

Instance Attribute Details

#comment ⇒ String?

Returns Description of this schedule.

Returns:

  • (String, nil) —

    Description of this schedule.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def comment
  @comment
end

#day_of_month ⇒ Array<Range>

Returns Day of month range to match, 1-31. Default matches all days.

Returns:

  • (Array<Range>) —

    Day of month range to match, 1-31. Default matches all days.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def day_of_month
  @day_of_month
end

#day_of_week ⇒ Array<Range>

Returns Day of week range to match, 0-6, 0 is Sunday. Default matches all days.

Returns:

  • (Array<Range>) —

    Day of week range to match, 0-6, 0 is Sunday. Default matches all days.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def day_of_week
  @day_of_week
end

#hour ⇒ Array<Range>

Returns Hour range to match, 0-23. Default matches 0.

Returns:

  • (Array<Range>) —

    Hour range to match, 0-23. Default matches 0.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def hour
  @hour
end

#minute ⇒ Array<Range>

Returns Minute range to match, 0-59. Default matches 0.

Returns:

  • (Array<Range>) —

    Minute range to match, 0-59. Default matches 0.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def minute
  @minute
end

#month ⇒ Array<Range>

Returns Month range to match, 1-12. Default matches all months.

Returns:

  • (Array<Range>) —

    Month range to match, 1-12. Default matches all months.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def month
  @month
end

#second ⇒ Array<Range>

Returns Second range to match, 0-59. Default matches 0.

Returns:

  • (Array<Range>) —

    Second range to match, 0-59. Default matches 0.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def second
  @second
end

#year ⇒ Array<Range>

Returns Optional year range to match. Default of empty matches all years.

Returns:

  • (Array<Range>) —

    Optional year range to match. Default of empty matches all years.



530
531
532
 
# File 'lib/temporalio/client/schedule.rb', line 530

def year
  @year
end