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

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

Overview

Description of a 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.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/temporalio/client/schedule.rb', line 76

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

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

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

#info ⇒ Schedule::Info

Returns Information about the schedule.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/temporalio/client/schedule.rb', line 76

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

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

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

#raw_description ⇒ Api::WorkflowService::V1::DescribeScheduleResponse

Returns Raw description of the schedule.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/temporalio/client/schedule.rb', line 76

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

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

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

#schedule ⇒ Schedule

Returns Schedule details.

Returns:



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/temporalio/client/schedule.rb', line 76

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

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

  # @return [SearchAttributes, 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.



92
93
94
 
# File 'lib/temporalio/client/schedule.rb', line 92

def memo
  @memo.get
end

#search_attributes ⇒ SearchAttributes?

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

Returns:

  • (SearchAttributes, nil) —

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



97
98
99
 
# File 'lib/temporalio/client/schedule.rb', line 97

def search_attributes
  @search_attributes.get
end