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.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/temporalio/client/schedule.rb', line 661

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.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/temporalio/client/schedule.rb', line 661

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.



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/temporalio/client/schedule.rb', line 661

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 



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

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.



670
671
672
673
674
675
676
 
# File 'lib/temporalio/client/schedule.rb', line 670

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