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

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

Overview

Description of a listed schedule.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#idString

Returns ID of the schedule.

Returns:

  • (String)

    ID of the schedule.



878
879
880
# File 'lib/temporalio/client/schedule.rb', line 878

def id
  @id
end

#infoInfo?

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
# File 'lib/temporalio/client/schedule.rb', line 878

def info
  @info
end

#raw_entryApi::Schedule::V1::ScheduleListEntry

Returns Raw description of the schedule.

Returns:



878
879
880
# File 'lib/temporalio/client/schedule.rb', line 878

def raw_entry
  @raw_entry
end

#scheduleSchedule?

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
# File 'lib/temporalio/client/schedule.rb', line 878

def schedule
  @schedule
end

Instance Method Details

#memoHash<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_attributesSearch 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