Class: Temporalio::Client::Schedule::List::State

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

Overview

State of a listed schedule.

Instance Attribute Summary collapse

Instance Attribute Details

#note ⇒ String?

Returns Human readable message for the schedule. The system may overwrite this value on certain conditions like pause-on-failure.

Returns:

  • (String, nil) —

    Human readable message for the schedule. The system may overwrite this value on certain conditions like pause-on-failure.



985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/temporalio/client/schedule.rb', line 985

class State
  # @!visibility private
  def initialize(raw_info:)
    # steep:ignore:start
    super(
      note: Internal::ProtoUtils.string_or(raw_info.notes),
      paused: raw_info.paused
    )
    # steep:ignore:end
  end
end

#paused ⇒ Boolean

Returns Whether the schedule is paused.

Returns:

  • (Boolean) —

    Whether the schedule is paused.



985
986
987
988
989
990
991
992
993
994
995
 
# File 'lib/temporalio/client/schedule.rb', line 985

class State
  # @!visibility private
  def initialize(raw_info:)
    # steep:ignore:start
    super(
      note: Internal::ProtoUtils.string_or(raw_info.notes),
      paused: raw_info.paused
    )
    # steep:ignore:end
  end
end