Class: Temporalio::Client::Schedule::Backfill

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

Overview

Time period and policy for actions taken as if the time passed right now.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(start_at:, end_at:, overlap: nil) ⇒ Backfill

Create backfill.

Parameters:

  • start_at (Time) —

    Start of the range to evaluate the schedule in. This is exclusive.

  • end_at (Time) —

    End of the range to evaluate the schedule in. This is inclusive.

  • overlap (OverlapPolicy) (defaults to: nil) —

    Overlap policy.



368
369
370
371
372
373
374
 
# File 'lib/temporalio/client/schedule.rb', line 368

def initialize(
  start_at:,
  end_at:,
  overlap: nil
)
  super
end

Instance Attribute Details

#end_at ⇒ Time

Returns End of the range to evaluate the schedule in. This is inclusive.

Returns:

  • (Time) —

    End of the range to evaluate the schedule in. This is inclusive.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/temporalio/client/schedule.rb', line 362

class Backfill
  # Create backfill.
  #
  # @param start_at [Time] Start of the range to evaluate the schedule in. This is exclusive.
  # @param end_at [Time] End of the range to evaluate the schedule in. This is inclusive.
  # @param overlap [OverlapPolicy] Overlap policy.
  def initialize(
    start_at:,
    end_at:,
    overlap: nil
  )
    super
  end

  # @!visibility private
  def _to_proto
    Api::Schedule::V1::BackfillRequest.new(
      start_time: Internal::ProtoUtils.time_to_timestamp(start_at),
      end_time: Internal::ProtoUtils.time_to_timestamp(end_at),
      overlap_policy: overlap || Api::Enums::V1::ScheduleOverlapPolicy::SCHEDULE_OVERLAP_POLICY_UNSPECIFIED
    )
  end
end

#overlap ⇒ OverlapPolicy

Returns Overlap policy.

Returns:



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/temporalio/client/schedule.rb', line 362

class Backfill
  # Create backfill.
  #
  # @param start_at [Time] Start of the range to evaluate the schedule in. This is exclusive.
  # @param end_at [Time] End of the range to evaluate the schedule in. This is inclusive.
  # @param overlap [OverlapPolicy] Overlap policy.
  def initialize(
    start_at:,
    end_at:,
    overlap: nil
  )
    super
  end

  # @!visibility private
  def _to_proto
    Api::Schedule::V1::BackfillRequest.new(
      start_time: Internal::ProtoUtils.time_to_timestamp(start_at),
      end_time: Internal::ProtoUtils.time_to_timestamp(end_at),
      overlap_policy: overlap || Api::Enums::V1::ScheduleOverlapPolicy::SCHEDULE_OVERLAP_POLICY_UNSPECIFIED
    )
  end
end

#start_at ⇒ Time

Returns Start of the range to evaluate the schedule in. This is exclusive.

Returns:

  • (Time) —

    Start of the range to evaluate the schedule in. This is exclusive.



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/temporalio/client/schedule.rb', line 362

class Backfill
  # Create backfill.
  #
  # @param start_at [Time] Start of the range to evaluate the schedule in. This is exclusive.
  # @param end_at [Time] End of the range to evaluate the schedule in. This is inclusive.
  # @param overlap [OverlapPolicy] Overlap policy.
  def initialize(
    start_at:,
    end_at:,
    overlap: nil
  )
    super
  end

  # @!visibility private
  def _to_proto
    Api::Schedule::V1::BackfillRequest.new(
      start_time: Internal::ProtoUtils.time_to_timestamp(start_at),
      end_time: Internal::ProtoUtils.time_to_timestamp(end_at),
      overlap_policy: overlap || Api::Enums::V1::ScheduleOverlapPolicy::SCHEDULE_OVERLAP_POLICY_UNSPECIFIED
    )
  end
end