Class: Temporalio::Client::Schedule::Range

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

Overview

Inclusive range for a schedule match value.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#finish ⇒ Integer

Returns Inclusive end of the range. If unset or less than start, defaults to start.

Returns:

  • (Integer) —

    Inclusive end of the range. If unset or less than start, defaults to start.



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/temporalio/client/schedule.rb', line 637

class Range
  class << self
    alias _original_new new

    # Create inclusive range.
    #
    # @param start [Integer] Inclusive start of the range.
    # @param finish [Integer] Inclusive end of the range. If unset or less than start, defaults to start.
    # @param step [Integer] Step to take between each value. Defaults as 1.
    def new(start, finish = [0, start].max, step = 1)
      _original_new( # steep:ignore
        start:,
        finish:,
        step:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_range)
    Schedule::Range.new(
      raw_range.start,
      raw_range.end,
      raw_range.step
    )
  end

  # @!visibility private
  def self._from_protos(raw_ranges)
    raw_ranges.map { |v| _from_proto(v) }
  end

  # @!visibility private
  def self._to_protos(ranges)
    ranges.map(&:_to_proto)
  end

  # @!visibility private
  def _to_proto
    Api::Schedule::V1::Range.new(
      start:,
      end: finish,
      step:
    )
  end
end

#start ⇒ Integer

Returns Inclusive start of the range.

Returns:

  • (Integer) —

    Inclusive start of the range.



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/temporalio/client/schedule.rb', line 637

class Range
  class << self
    alias _original_new new

    # Create inclusive range.
    #
    # @param start [Integer] Inclusive start of the range.
    # @param finish [Integer] Inclusive end of the range. If unset or less than start, defaults to start.
    # @param step [Integer] Step to take between each value. Defaults as 1.
    def new(start, finish = [0, start].max, step = 1)
      _original_new( # steep:ignore
        start:,
        finish:,
        step:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_range)
    Schedule::Range.new(
      raw_range.start,
      raw_range.end,
      raw_range.step
    )
  end

  # @!visibility private
  def self._from_protos(raw_ranges)
    raw_ranges.map { |v| _from_proto(v) }
  end

  # @!visibility private
  def self._to_protos(ranges)
    ranges.map(&:_to_proto)
  end

  # @!visibility private
  def _to_proto
    Api::Schedule::V1::Range.new(
      start:,
      end: finish,
      step:
    )
  end
end

#step ⇒ Integer

Returns Step to take between each value. Defaults as 1.

Returns:

  • (Integer) —

    Step to take between each value. Defaults as 1.



637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 
# File 'lib/temporalio/client/schedule.rb', line 637

class Range
  class << self
    alias _original_new new

    # Create inclusive range.
    #
    # @param start [Integer] Inclusive start of the range.
    # @param finish [Integer] Inclusive end of the range. If unset or less than start, defaults to start.
    # @param step [Integer] Step to take between each value. Defaults as 1.
    def new(start, finish = [0, start].max, step = 1)
      _original_new( # steep:ignore
        start:,
        finish:,
        step:
      )
    end
  end

  # @!visibility private
  def self._from_proto(raw_range)
    Schedule::Range.new(
      raw_range.start,
      raw_range.end,
      raw_range.step
    )
  end

  # @!visibility private
  def self._from_protos(raw_ranges)
    raw_ranges.map { |v| _from_proto(v) }
  end

  # @!visibility private
  def self._to_protos(ranges)
    ranges.map(&:_to_proto)
  end

  # @!visibility private
  def _to_proto
    Api::Schedule::V1::Range.new(
      start:,
      end: finish,
      step:
    )
  end
end

Class Method Details

._original_new ⇒ Object 



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

alias _original_new new

.new(start, finish = [0, start].max, step = 1) ⇒ Object

Create inclusive range.

Parameters:

  • start (Integer) —

    Inclusive start of the range.

  • finish (Integer) (defaults to: [0, start].max) —

    Inclusive end of the range. If unset or less than start, defaults to start.

  • step (Integer) (defaults to: 1) —

    Step to take between each value. Defaults as 1.



646
647
648
649
650
651
652
 
# File 'lib/temporalio/client/schedule.rb', line 646

def new(start, finish = [0, start].max, step = 1)
  _original_new( # steep:ignore
    start:,
    finish:,
    step:
  )
end