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

Inherits:

Object

• Object
• Temporalio::Client::Schedule::Range

Defined in:

lib/temporalio/client/schedule.rb

Overview

Inclusive range for a schedule match value.

Instance Attribute Summary

• #finish ⇒ Integer

  Inclusive end of the range.

• #start ⇒ Integer

  Inclusive start of the range.

• #step ⇒ Integer

  Step to take between each value.

Class Method Summary

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

  Create inclusive range.

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.

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

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.

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

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.

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

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

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

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.

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

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