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.



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/temporalio/client/schedule.rb', line 846

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.



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/temporalio/client/schedule.rb', line 846

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:



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/temporalio/client/schedule.rb', line 846

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.



846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
 
# File 'lib/temporalio/client/schedule.rb', line 846

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.



862
863
864
 
# File 'lib/temporalio/client/schedule.rb', line 862

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.



867
868
869
 
# File 'lib/temporalio/client/schedule.rb', line 867

def search_attributes
  @search_attributes.get
end