Class: AWS::Flow::ActivityOptions

Inherits:

Options

• Object
• Options
• AWS::Flow::ActivityOptions

Includes:

OptionsMethods

Defined in:

lib/aws/decider/options.rb

Overview

Options to use on an activity or decider. The following options are defined:

Direct Known Subclasses

ActivityRuntimeOptions

Instance Attribute Summary

• #default_task_heartbeat_timeout ⇒ Object

  The optional default maximum time, specified when registering the activity type, before which a worker processing a task must report progress by calling record_heartbeat on the ‘ActivityTask`.

• #default_task_list ⇒ Object

  The optional default task list specified for this activity type at registration.

• #default_task_schedule_to_close_timeout ⇒ Object

  The optional default maximum duration, specified when registering the activity type, for tasks of this activity type.

• #default_task_schedule_to_start_timeout ⇒ Object

  The optional default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker.

• #default_task_start_to_close_timeout ⇒ Object

  The optional default maximum duration for tasks of an activity type specified when registering the activity type.

Attributes included from Utilities::UpwardLookups

#precursors

Attributes included from Utilities::UpwardLookups::InstanceMethods

#precursors

Instance Method Summary

• #activity_name ⇒ String

  Gets the activity prefix name.

• #activity_name=(value) ⇒ Object

  Sets the activity prefix name.

• #default_keys ⇒ Object

  This method provides the default option keys for activities.

• #exponential_retry(&block) ⇒ Object

  Retries the supplied block with exponential retry logic.

• #initialize(default_options = {}, use_defaults = false) ⇒ ActivityOptions constructor

  Creates a new set of ‘ActivityOptions`.

• #make_runtime_key(key) ⇒ Object

  This method converts default option keys to runtime keys by replacing “default_task_” in the key name.

Methods included from OptionsMethods

#get_default_options, #get_full_options, #get_runtime_options

Methods inherited from Options

#get_options, inherited, #method_missing

Methods included from Utilities::UpwardLookups

#held_properties, #properties, #property

Methods included from Utilities::UpwardLookups::InstanceMethods

#look_upwards

Constructor Details

#initialize(default_options = {}, use_defaults = false) ⇒ ActivityOptions

Creates a new set of ‘ActivityOptions`.

Parameters:

• default_options (Hash) (defaults to: {}) —

  A set of ‘ActivityOptions` to use as the default values.

• use_defaults (true, false) (defaults to: false) —

  Set to ‘true` to use the pre-defined AWS::Flow::ActivityDefaults.

Options Hash (default_options):

• :heartbeat_timeout (Integer) —

  The optional default maximum time, specified when registering the activity type, before which a worker processing a task must report progress by calling ‘RecordActivityTaskHeartbeat`.

  You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

• :schedule_to_close_timeout (Integer) —

  The optional default maximum duration, specified when registering the activity type, for tasks of this activity type.

  You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision.

• :schedule_to_start_timeout (Integer) —

  The optional default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker.

  You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision.

• :start_to_close_timeout (Integer) —

  The optional default maximum duration for tasks of an activity type specified when registering the activity type.

  You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision.

• :task_list (Array) —

  The optional default task list specified for this activity type at registration. This default task list is used if a task list is not provided when a task is scheduled through the ScheduleActivityTask decision.

  You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision.

• :version (String) —

  The version of this activity. If you change any other options on the activity, you must also change the version.

# File 'lib/aws/decider/options.rb', line 762

def initialize(default_options={}, use_defaults=false)
  if default_options.keys.include? :exponential_retry
    @_exponential_retry = ExponentialRetryOptions.new(default_options[:exponential_retry])
  end
  super(default_options, use_defaults)
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class AWS::Flow::Options

Instance Attribute Details

#default_task_heartbeat_timeout ⇒ Object

The optional default maximum time, specified when registering the activity type, before which a worker processing a task must report progress by calling record_heartbeat on the ‘ActivityTask`.

You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision. If the activity worker subsequently attempts to record a heartbeat or returns a result, the activity worker receives an UnknownResource fault. In this case, Amazon SWF no longer considers the activity task to be valid; the activity worker should clean up the activity task.

The valid values are integers greater than or equal to zero. An integer value can be used to specify the duration in seconds while “NONE” can be used to specify unlimited duration.

# File 'lib/aws/decider/options.rb', line 642

class ActivityOptions < Options
  include OptionsMethods

  properties(
    :heartbeat_timeout,
    :task_list,
    :schedule_to_close_timeout,
    :schedule_to_start_timeout,
    :start_to_close_timeout,
    :version,
    :input
  )

  # Adding default properties
  properties(
    :default_task_heartbeat_timeout,
    :default_task_list,
    :default_task_schedule_to_close_timeout,
    :default_task_schedule_to_start_timeout,
    :default_task_start_to_close_timeout,
  )

  property(:manual_completion, [lambda {|x| x == true}])
  property(:data_converter, [])

  default_classes << ActivityDefaults.new

  # This method provides the default option keys for activities
  def default_keys
    [:default_task_heartbeat_timeout,
     :default_task_schedule_to_close_timeout,
     :default_task_schedule_to_start_timeout,
     :default_task_start_to_close_timeout,
     :default_task_list]
  end

  # This method converts default option keys to runtime keys by replacing
  # "default_task_" in the key name. It handles the exception of task_list
  # where only "default_" needs to be replaced.
  def make_runtime_key(key)
    if key =~ /task_list/
      key.to_s.gsub(/default_/, "").to_sym
    else
      key.to_s.gsub(/default_task_/, "").to_sym
    end
  end

  # Gets the activity prefix name.
  #
  # @return [String]
  #   The activity name.
  #
  def activity_name
    @prefix_name
  end

  # Sets the activity prefix name.
  #
  # @param [String] value
  #   The activity name to set.
  #
  def activity_name=(value)
    @prefix_name = value
  end

  # Creates a new set of `ActivityOptions`.
  #
  # @param [Hash] default_options
  #   A set of `ActivityOptions` to use as the default values.
  #
  # @option default_options [Integer] :heartbeat_timeout
  #   The optional default maximum time, specified when registering the
  #   activity type, before which a worker processing a task must report
  #   progress by calling `RecordActivityTaskHeartbeat`.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision. If the activity worker subsequently
  #   attempts to record a heartbeat or returns a result, the activity
  #   worker receives an UnknownResource fault. In this case, Amazon SWF no
  #   longer considers the activity task to be valid; the activity worker
  #   should clean up the activity task.
  #
  # @option default_options [Integer] :schedule_to_close_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, for tasks of this activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :schedule_to_start_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, that a task of an activity type can wait before being
  #   assigned to a worker.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :start_to_close_timeout
  #   The optional default maximum duration for tasks of an activity type
  #   specified when registering the activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Array] :task_list
  #   The optional default task list specified for this activity type at
  #   registration. This default task list is used if a task list is not
  #   provided when a task is scheduled through the ScheduleActivityTask
  #   decision.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [String] :version
  #  The version of this activity. If you change any other options on the
  #  activity, you must also change the version.
  #
  # @param [true, false] use_defaults
  #   Set to `true` to use the pre-defined {ActivityDefaults}.
  #
  def initialize(default_options={}, use_defaults=false)
    if default_options.keys.include? :exponential_retry
      @_exponential_retry = ExponentialRetryOptions.new(default_options[:exponential_retry])
    end
    super(default_options, use_defaults)
  end

  property(:_exponential_retry, [])

  # Retries the supplied block with exponential retry logic.
  #
  # @param [Hash] block
  #   A hash of {ExponentialRetryOptions}.
  #
  def exponential_retry(&block)
    retry_options = Utilities::interpret_block_for_options(ExponentialRetryOptions, block)
    @_exponential_retry = retry_options
  end
end

#default_task_list ⇒ Object

The optional default task list specified for this activity type at registration. This default task list is used if a task list is not provided when a task is scheduled through the ‘ScheduleActivityTask` decision. You can override this default when scheduling a task through the `ScheduleActivityTask` decision.

# File 'lib/aws/decider/options.rb', line 642

class ActivityOptions < Options
  include OptionsMethods

  properties(
    :heartbeat_timeout,
    :task_list,
    :schedule_to_close_timeout,
    :schedule_to_start_timeout,
    :start_to_close_timeout,
    :version,
    :input
  )

  # Adding default properties
  properties(
    :default_task_heartbeat_timeout,
    :default_task_list,
    :default_task_schedule_to_close_timeout,
    :default_task_schedule_to_start_timeout,
    :default_task_start_to_close_timeout,
  )

  property(:manual_completion, [lambda {|x| x == true}])
  property(:data_converter, [])

  default_classes << ActivityDefaults.new

  # This method provides the default option keys for activities
  def default_keys
    [:default_task_heartbeat_timeout,
     :default_task_schedule_to_close_timeout,
     :default_task_schedule_to_start_timeout,
     :default_task_start_to_close_timeout,
     :default_task_list]
  end

  # This method converts default option keys to runtime keys by replacing
  # "default_task_" in the key name. It handles the exception of task_list
  # where only "default_" needs to be replaced.
  def make_runtime_key(key)
    if key =~ /task_list/
      key.to_s.gsub(/default_/, "").to_sym
    else
      key.to_s.gsub(/default_task_/, "").to_sym
    end
  end

  # Gets the activity prefix name.
  #
  # @return [String]
  #   The activity name.
  #
  def activity_name
    @prefix_name
  end

  # Sets the activity prefix name.
  #
  # @param [String] value
  #   The activity name to set.
  #
  def activity_name=(value)
    @prefix_name = value
  end

  # Creates a new set of `ActivityOptions`.
  #
  # @param [Hash] default_options
  #   A set of `ActivityOptions` to use as the default values.
  #
  # @option default_options [Integer] :heartbeat_timeout
  #   The optional default maximum time, specified when registering the
  #   activity type, before which a worker processing a task must report
  #   progress by calling `RecordActivityTaskHeartbeat`.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision. If the activity worker subsequently
  #   attempts to record a heartbeat or returns a result, the activity
  #   worker receives an UnknownResource fault. In this case, Amazon SWF no
  #   longer considers the activity task to be valid; the activity worker
  #   should clean up the activity task.
  #
  # @option default_options [Integer] :schedule_to_close_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, for tasks of this activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :schedule_to_start_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, that a task of an activity type can wait before being
  #   assigned to a worker.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :start_to_close_timeout
  #   The optional default maximum duration for tasks of an activity type
  #   specified when registering the activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Array] :task_list
  #   The optional default task list specified for this activity type at
  #   registration. This default task list is used if a task list is not
  #   provided when a task is scheduled through the ScheduleActivityTask
  #   decision.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [String] :version
  #  The version of this activity. If you change any other options on the
  #  activity, you must also change the version.
  #
  # @param [true, false] use_defaults
  #   Set to `true` to use the pre-defined {ActivityDefaults}.
  #
  def initialize(default_options={}, use_defaults=false)
    if default_options.keys.include? :exponential_retry
      @_exponential_retry = ExponentialRetryOptions.new(default_options[:exponential_retry])
    end
    super(default_options, use_defaults)
  end

  property(:_exponential_retry, [])

  # Retries the supplied block with exponential retry logic.
  #
  # @param [Hash] block
  #   A hash of {ExponentialRetryOptions}.
  #
  def exponential_retry(&block)
    retry_options = Utilities::interpret_block_for_options(ExponentialRetryOptions, block)
    @_exponential_retry = retry_options
  end
end

#default_task_schedule_to_close_timeout ⇒ Object

The optional default maximum duration, specified when registering the activity type, for tasks of this activity type. You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision.

The valid values are integers greater than or equal to zero, or the string “NONE”. An integer value can be used to specify the duration in seconds while “NONE” is be used to specify unlimited duration.

# File 'lib/aws/decider/options.rb', line 642

class ActivityOptions < Options
  include OptionsMethods

  properties(
    :heartbeat_timeout,
    :task_list,
    :schedule_to_close_timeout,
    :schedule_to_start_timeout,
    :start_to_close_timeout,
    :version,
    :input
  )

  # Adding default properties
  properties(
    :default_task_heartbeat_timeout,
    :default_task_list,
    :default_task_schedule_to_close_timeout,
    :default_task_schedule_to_start_timeout,
    :default_task_start_to_close_timeout,
  )

  property(:manual_completion, [lambda {|x| x == true}])
  property(:data_converter, [])

  default_classes << ActivityDefaults.new

  # This method provides the default option keys for activities
  def default_keys
    [:default_task_heartbeat_timeout,
     :default_task_schedule_to_close_timeout,
     :default_task_schedule_to_start_timeout,
     :default_task_start_to_close_timeout,
     :default_task_list]
  end

  # This method converts default option keys to runtime keys by replacing
  # "default_task_" in the key name. It handles the exception of task_list
  # where only "default_" needs to be replaced.
  def make_runtime_key(key)
    if key =~ /task_list/
      key.to_s.gsub(/default_/, "").to_sym
    else
      key.to_s.gsub(/default_task_/, "").to_sym
    end
  end

  # Gets the activity prefix name.
  #
  # @return [String]
  #   The activity name.
  #
  def activity_name
    @prefix_name
  end

  # Sets the activity prefix name.
  #
  # @param [String] value
  #   The activity name to set.
  #
  def activity_name=(value)
    @prefix_name = value
  end

  # Creates a new set of `ActivityOptions`.
  #
  # @param [Hash] default_options
  #   A set of `ActivityOptions` to use as the default values.
  #
  # @option default_options [Integer] :heartbeat_timeout
  #   The optional default maximum time, specified when registering the
  #   activity type, before which a worker processing a task must report
  #   progress by calling `RecordActivityTaskHeartbeat`.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision. If the activity worker subsequently
  #   attempts to record a heartbeat or returns a result, the activity
  #   worker receives an UnknownResource fault. In this case, Amazon SWF no
  #   longer considers the activity task to be valid; the activity worker
  #   should clean up the activity task.
  #
  # @option default_options [Integer] :schedule_to_close_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, for tasks of this activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :schedule_to_start_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, that a task of an activity type can wait before being
  #   assigned to a worker.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :start_to_close_timeout
  #   The optional default maximum duration for tasks of an activity type
  #   specified when registering the activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Array] :task_list
  #   The optional default task list specified for this activity type at
  #   registration. This default task list is used if a task list is not
  #   provided when a task is scheduled through the ScheduleActivityTask
  #   decision.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [String] :version
  #  The version of this activity. If you change any other options on the
  #  activity, you must also change the version.
  #
  # @param [true, false] use_defaults
  #   Set to `true` to use the pre-defined {ActivityDefaults}.
  #
  def initialize(default_options={}, use_defaults=false)
    if default_options.keys.include? :exponential_retry
      @_exponential_retry = ExponentialRetryOptions.new(default_options[:exponential_retry])
    end
    super(default_options, use_defaults)
  end

  property(:_exponential_retry, [])

  # Retries the supplied block with exponential retry logic.
  #
  # @param [Hash] block
  #   A hash of {ExponentialRetryOptions}.
  #
  def exponential_retry(&block)
    retry_options = Utilities::interpret_block_for_options(ExponentialRetryOptions, block)
    @_exponential_retry = retry_options
  end
end

#default_task_schedule_to_start_timeout ⇒ Object

The optional default maximum duration, specified when registering the activity type, that a task of an activity type can wait before being assigned to a worker. You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision.

# File 'lib/aws/decider/options.rb', line 642

class ActivityOptions < Options
  include OptionsMethods

  properties(
    :heartbeat_timeout,
    :task_list,
    :schedule_to_close_timeout,
    :schedule_to_start_timeout,
    :start_to_close_timeout,
    :version,
    :input
  )

  # Adding default properties
  properties(
    :default_task_heartbeat_timeout,
    :default_task_list,
    :default_task_schedule_to_close_timeout,
    :default_task_schedule_to_start_timeout,
    :default_task_start_to_close_timeout,
  )

  property(:manual_completion, [lambda {|x| x == true}])
  property(:data_converter, [])

  default_classes << ActivityDefaults.new

  # This method provides the default option keys for activities
  def default_keys
    [:default_task_heartbeat_timeout,
     :default_task_schedule_to_close_timeout,
     :default_task_schedule_to_start_timeout,
     :default_task_start_to_close_timeout,
     :default_task_list]
  end

  # This method converts default option keys to runtime keys by replacing
  # "default_task_" in the key name. It handles the exception of task_list
  # where only "default_" needs to be replaced.
  def make_runtime_key(key)
    if key =~ /task_list/
      key.to_s.gsub(/default_/, "").to_sym
    else
      key.to_s.gsub(/default_task_/, "").to_sym
    end
  end

  # Gets the activity prefix name.
  #
  # @return [String]
  #   The activity name.
  #
  def activity_name
    @prefix_name
  end

  # Sets the activity prefix name.
  #
  # @param [String] value
  #   The activity name to set.
  #
  def activity_name=(value)
    @prefix_name = value
  end

  # Creates a new set of `ActivityOptions`.
  #
  # @param [Hash] default_options
  #   A set of `ActivityOptions` to use as the default values.
  #
  # @option default_options [Integer] :heartbeat_timeout
  #   The optional default maximum time, specified when registering the
  #   activity type, before which a worker processing a task must report
  #   progress by calling `RecordActivityTaskHeartbeat`.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision. If the activity worker subsequently
  #   attempts to record a heartbeat or returns a result, the activity
  #   worker receives an UnknownResource fault. In this case, Amazon SWF no
  #   longer considers the activity task to be valid; the activity worker
  #   should clean up the activity task.
  #
  # @option default_options [Integer] :schedule_to_close_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, for tasks of this activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :schedule_to_start_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, that a task of an activity type can wait before being
  #   assigned to a worker.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :start_to_close_timeout
  #   The optional default maximum duration for tasks of an activity type
  #   specified when registering the activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Array] :task_list
  #   The optional default task list specified for this activity type at
  #   registration. This default task list is used if a task list is not
  #   provided when a task is scheduled through the ScheduleActivityTask
  #   decision.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [String] :version
  #  The version of this activity. If you change any other options on the
  #  activity, you must also change the version.
  #
  # @param [true, false] use_defaults
  #   Set to `true` to use the pre-defined {ActivityDefaults}.
  #
  def initialize(default_options={}, use_defaults=false)
    if default_options.keys.include? :exponential_retry
      @_exponential_retry = ExponentialRetryOptions.new(default_options[:exponential_retry])
    end
    super(default_options, use_defaults)
  end

  property(:_exponential_retry, [])

  # Retries the supplied block with exponential retry logic.
  #
  # @param [Hash] block
  #   A hash of {ExponentialRetryOptions}.
  #
  def exponential_retry(&block)
    retry_options = Utilities::interpret_block_for_options(ExponentialRetryOptions, block)
    @_exponential_retry = retry_options
  end
end

#default_task_start_to_close_timeout ⇒ Object

The optional default maximum duration for tasks of an activity type specified when registering the activity type. You can override this default when scheduling a task through the ‘ScheduleActivityTask` decision.

# File 'lib/aws/decider/options.rb', line 642

class ActivityOptions < Options
  include OptionsMethods

  properties(
    :heartbeat_timeout,
    :task_list,
    :schedule_to_close_timeout,
    :schedule_to_start_timeout,
    :start_to_close_timeout,
    :version,
    :input
  )

  # Adding default properties
  properties(
    :default_task_heartbeat_timeout,
    :default_task_list,
    :default_task_schedule_to_close_timeout,
    :default_task_schedule_to_start_timeout,
    :default_task_start_to_close_timeout,
  )

  property(:manual_completion, [lambda {|x| x == true}])
  property(:data_converter, [])

  default_classes << ActivityDefaults.new

  # This method provides the default option keys for activities
  def default_keys
    [:default_task_heartbeat_timeout,
     :default_task_schedule_to_close_timeout,
     :default_task_schedule_to_start_timeout,
     :default_task_start_to_close_timeout,
     :default_task_list]
  end

  # This method converts default option keys to runtime keys by replacing
  # "default_task_" in the key name. It handles the exception of task_list
  # where only "default_" needs to be replaced.
  def make_runtime_key(key)
    if key =~ /task_list/
      key.to_s.gsub(/default_/, "").to_sym
    else
      key.to_s.gsub(/default_task_/, "").to_sym
    end
  end

  # Gets the activity prefix name.
  #
  # @return [String]
  #   The activity name.
  #
  def activity_name
    @prefix_name
  end

  # Sets the activity prefix name.
  #
  # @param [String] value
  #   The activity name to set.
  #
  def activity_name=(value)
    @prefix_name = value
  end

  # Creates a new set of `ActivityOptions`.
  #
  # @param [Hash] default_options
  #   A set of `ActivityOptions` to use as the default values.
  #
  # @option default_options [Integer] :heartbeat_timeout
  #   The optional default maximum time, specified when registering the
  #   activity type, before which a worker processing a task must report
  #   progress by calling `RecordActivityTaskHeartbeat`.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision. If the activity worker subsequently
  #   attempts to record a heartbeat or returns a result, the activity
  #   worker receives an UnknownResource fault. In this case, Amazon SWF no
  #   longer considers the activity task to be valid; the activity worker
  #   should clean up the activity task.
  #
  # @option default_options [Integer] :schedule_to_close_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, for tasks of this activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :schedule_to_start_timeout
  #   The optional default maximum duration, specified when registering the
  #   activity type, that a task of an activity type can wait before being
  #   assigned to a worker.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Integer] :start_to_close_timeout
  #   The optional default maximum duration for tasks of an activity type
  #   specified when registering the activity type.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [Array] :task_list
  #   The optional default task list specified for this activity type at
  #   registration. This default task list is used if a task list is not
  #   provided when a task is scheduled through the ScheduleActivityTask
  #   decision.
  #
  #   You can override this default when scheduling a task through the
  #   `ScheduleActivityTask` decision.
  #
  # @option default_options [String] :version
  #  The version of this activity. If you change any other options on the
  #  activity, you must also change the version.
  #
  # @param [true, false] use_defaults
  #   Set to `true` to use the pre-defined {ActivityDefaults}.
  #
  def initialize(default_options={}, use_defaults=false)
    if default_options.keys.include? :exponential_retry
      @_exponential_retry = ExponentialRetryOptions.new(default_options[:exponential_retry])
    end
    super(default_options, use_defaults)
  end

  property(:_exponential_retry, [])

  # Retries the supplied block with exponential retry logic.
  #
  # @param [Hash] block
  #   A hash of {ExponentialRetryOptions}.
  #
  def exponential_retry(&block)
    retry_options = Utilities::interpret_block_for_options(ExponentialRetryOptions, block)
    @_exponential_retry = retry_options
  end
end

Instance Method Details

#activity_name ⇒ String

Gets the activity prefix name.

Returns:

• (String) —

  The activity name.

# File 'lib/aws/decider/options.rb', line 694

def activity_name
  @prefix_name
end

#activity_name=(value) ⇒ Object

Sets the activity prefix name.

Parameters:

• value (String) —

  The activity name to set.

# File 'lib/aws/decider/options.rb', line 703

def activity_name=(value)
  @prefix_name = value
end

#default_keys ⇒ Object

This method provides the default option keys for activities

# File 'lib/aws/decider/options.rb', line 670

def default_keys
  [:default_task_heartbeat_timeout,
   :default_task_schedule_to_close_timeout,
   :default_task_schedule_to_start_timeout,
   :default_task_start_to_close_timeout,
   :default_task_list]
end

#exponential_retry(&block) ⇒ Object

Retries the supplied block with exponential retry logic.

Parameters:

• block (Hash) —

  A hash of ExponentialRetryOptions.

# File 'lib/aws/decider/options.rb', line 776

def exponential_retry(&block)
  retry_options = Utilities::interpret_block_for_options(ExponentialRetryOptions, block)
  @_exponential_retry = retry_options
end

#make_runtime_key(key) ⇒ Object

This method converts default option keys to runtime keys by replacing “default_task_” in the key name. It handles the exception of task_list where only “default_” needs to be replaced.

# File 'lib/aws/decider/options.rb', line 681

def make_runtime_key(key)
  if key =~ /task_list/
    key.to_s.gsub(/default_/, "").to_sym
  else
    key.to_s.gsub(/default_task_/, "").to_sym
  end
end