Class: Temporalio::Client::Schedule::Update

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

Overview

Result of an update callback for Temporalio::Client::ScheduleHandle#update.

Constant Summary collapse

Input =

Parameter for an update callback for Temporalio::Client::ScheduleHandle#update.

Data.define( # rubocop:disable Layout/ClassStructure
  :description
)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(schedule:, search_attributes: nil) ⇒ Update

Create an update callback result.

Parameters:

  • schedule (Schedule) —

    Schedule to update.

  • search_attributes (SearchAttributes, nil) (defaults to: nil) —

    Search attributes to update to.



837
838
839
 
# File 'lib/temporalio/client/schedule.rb', line 837

def initialize(schedule:, search_attributes: nil)
  super
end

Instance Attribute Details

#description ⇒ Description

Returns Current description of the schedule.

Returns:

  • (Description) —

    Current description of the schedule.



845
846
847
 
# File 'lib/temporalio/client/schedule.rb', line 845

Input = Data.define( # rubocop:disable Layout/ClassStructure
  :description
)

#schedule ⇒ Schedule

Returns Schedule to update.

Returns:



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/temporalio/client/schedule.rb', line 832

class Update
  # Create an update callback result.
  #
  # @param schedule [Schedule] Schedule to update.
  # @param search_attributes [SearchAttributes, nil] Search attributes to update to.
  def initialize(schedule:, search_attributes: nil)
    super
  end

  # Parameter for an update callback for {ScheduleHandle.update}.
  #
  # @!attribute description
  #   @return [Description] Current description of the schedule.
  Input = Data.define( # rubocop:disable Layout/ClassStructure
    :description
  )
end

#search_attributes ⇒ SearchAttributes?

Returns Search attributes to update to.

Returns:



832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
 
# File 'lib/temporalio/client/schedule.rb', line 832

class Update
  # Create an update callback result.
  #
  # @param schedule [Schedule] Schedule to update.
  # @param search_attributes [SearchAttributes, nil] Search attributes to update to.
  def initialize(schedule:, search_attributes: nil)
    super
  end

  # Parameter for an update callback for {ScheduleHandle.update}.
  #
  # @!attribute description
  #   @return [Description] Current description of the schedule.
  Input = Data.define( # rubocop:disable Layout/ClassStructure
    :description
  )
end