Class: Temporalio::Client::Schedule::List::Description

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

Overview

Description of a listed schedule.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#id ⇒ String

Returns ID of the schedule.

Returns:

  • (String) —

    ID of the schedule.



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/temporalio/client/schedule.rb', line 878

class Description
  # @!visibility private
  def initialize(raw_entry:, data_converter:)
    @memo = Internal::ProtoUtils::LazyMemo.new(raw_entry.memo, data_converter)
    @search_attributes = Internal::ProtoUtils::LazySearchAttributes.new(raw_entry.search_attributes)
    # steep:ignore:start
    super(
      id: raw_entry.schedule_id,
      schedule: (Schedule.new(raw_info: raw_entry.info) if raw_entry.info),
      info: (Info.new(raw_info: raw_entry.info) if raw_entry.info),
      raw_entry:
    )
    # steep:ignore:end
  end

  # @return [Hash<String, Object>, nil] Memo for the schedule, converted lazily on first call.
  def memo
    @memo.get
  end

  # @return [Search attributes, nil] Search attributes for the schedule, converted lazily on first call.
  def search_attributes
    @search_attributes.get
  end
end

#info ⇒ Info?

Returns Information about the schedule. This may not be present in older Temporal servers without advanced visibility.

Returns:

  • (Info, nil) —

    Information about the schedule. This may not be present in older Temporal servers without advanced visibility.



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/temporalio/client/schedule.rb', line 878

class Description
  # @!visibility private
  def initialize(raw_entry:, data_converter:)
    @memo = Internal::ProtoUtils::LazyMemo.new(raw_entry.memo, data_converter)
    @search_attributes = Internal::ProtoUtils::LazySearchAttributes.new(raw_entry.search_attributes)
    # steep:ignore:start
    super(
      id: raw_entry.schedule_id,
      schedule: (Schedule.new(raw_info: raw_entry.info) if raw_entry.info),
      info: (Info.new(raw_info: raw_entry.info) if raw_entry.info),
      raw_entry:
    )
    # steep:ignore:end
  end

  # @return [Hash<String, Object>, nil] Memo for the schedule, converted lazily on first call.
  def memo
    @memo.get
  end

  # @return [Search attributes, nil] Search attributes for the schedule, converted lazily on first call.
  def search_attributes
    @search_attributes.get
  end
end

#raw_entry ⇒ Api::Schedule::V1::ScheduleListEntry

Returns Raw description of the schedule.

Returns:



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/temporalio/client/schedule.rb', line 878

class Description
  # @!visibility private
  def initialize(raw_entry:, data_converter:)
    @memo = Internal::ProtoUtils::LazyMemo.new(raw_entry.memo, data_converter)
    @search_attributes = Internal::ProtoUtils::LazySearchAttributes.new(raw_entry.search_attributes)
    # steep:ignore:start
    super(
      id: raw_entry.schedule_id,
      schedule: (Schedule.new(raw_info: raw_entry.info) if raw_entry.info),
      info: (Info.new(raw_info: raw_entry.info) if raw_entry.info),
      raw_entry:
    )
    # steep:ignore:end
  end

  # @return [Hash<String, Object>, nil] Memo for the schedule, converted lazily on first call.
  def memo
    @memo.get
  end

  # @return [Search attributes, nil] Search attributes for the schedule, converted lazily on first call.
  def search_attributes
    @search_attributes.get
  end
end

#schedule ⇒ Schedule?

Returns Schedule details that can be mutated. This may not be present in older Temporal servers without advanced visibility.

Returns:

  • (Schedule, nil) —

    Schedule details that can be mutated. This may not be present in older Temporal servers without advanced visibility.



878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
 
# File 'lib/temporalio/client/schedule.rb', line 878

class Description
  # @!visibility private
  def initialize(raw_entry:, data_converter:)
    @memo = Internal::ProtoUtils::LazyMemo.new(raw_entry.memo, data_converter)
    @search_attributes = Internal::ProtoUtils::LazySearchAttributes.new(raw_entry.search_attributes)
    # steep:ignore:start
    super(
      id: raw_entry.schedule_id,
      schedule: (Schedule.new(raw_info: raw_entry.info) if raw_entry.info),
      info: (Info.new(raw_info: raw_entry.info) if raw_entry.info),
      raw_entry:
    )
    # steep:ignore:end
  end

  # @return [Hash<String, Object>, nil] Memo for the schedule, converted lazily on first call.
  def memo
    @memo.get
  end

  # @return [Search attributes, nil] Search attributes for the schedule, converted lazily on first call.
  def search_attributes
    @search_attributes.get
  end
end

Instance Method Details

#memo ⇒ Hash<String, Object>?

Returns Memo for the schedule, converted lazily on first call.

Returns:

  • (Hash<String, Object>, nil) —

    Memo for the schedule, converted lazily on first call.



894
895
896
 
# File 'lib/temporalio/client/schedule.rb', line 894

def memo
  @memo.get
end

#search_attributes ⇒ Search attributes?

Returns Search attributes for the schedule, converted lazily on first call.

Returns:

  • (Search attributes, nil) —

    Search attributes for the schedule, converted lazily on first call.



899
900
901
 
# File 'lib/temporalio/client/schedule.rb', line 899

def search_attributes
  @search_attributes.get
end