Class AWS::SimpleWorkflow::ActivityTaskCollection
In: lib/aws/simple_workflow/activity_task_collection.rb
Parent: Object

Methods

Included Modules

Core::Model OptionFormatters

Attributes

domain  [R]  @return [Domain]

Public Class methods

Public Instance methods

Returns the number of tasks in the specified `task_list`.

    count = activity_tasks.count('task-list-name')
    count.truncated? #=> false
    count.to_i #=> 7

@note This operation is eventually consistent. The results are best

  effort and may not exactly reflect recent updates and changes.

@param [String] task_list The name of the task list.

@return [Count] Returns a possibly truncated count of

  pending activity tasks for the given `task_list`.

@param [String] task_list The task list to check for pending

  activity tasks in.

@param [Hash] options

@option options [String] :identity (nil) Identity of the worker

  making the request, which is recorded in the ActivityTaskStarted
  event in the workflow history. This enables diagnostic tracing
  when problems arise. The :identity defaults to the hostname and
  pid (e.g. "hostname:pid").

@yieldparam [ActivityTask] activity_task Yields if a task is

  available within 60 seconds.

@return [ActivityTask,nil] Returns an activity task when one is

   available, `nil` otherwise.  If you call this function with
   a block, `nil` is always returned.

[Validate]