class AWS::SimpleWorkflow::WorkflowExecution

@attr_reader [Symbol] child_policy The policy to use for the child

workflow executions if this workflow execution is terminated. 
The return value will be one of the following values:

* +:terminate+ - the child executions will be terminated.

* +:request_cancel+ - a request to cancel will be attempted for each
  child execution by recording a WorkflowExecutionCancelRequested 
  event in its history. It is up to the decider to take appropriate
  actions when it receives an execution history with this event.

* +:abandon+ - no action will be taken. The child executions will 
  continue to run.

@attr_reader [String] start_to_close_timeout The total allowed

duration for this workflow execution.

The return value will be formatted as an ISO 8601 duration (e.g.
'PnYnMnDTnHnMnS').

@attr_reader [String] task_list The task list used for the decision

tasks generated for this workflow execution.

@attr_reader [String] task_start_to_close_timeout The maximum duration

allowed for decision tasks for this workflow execution.

The return value will be formatted as an ISO 8601 duration (e.g.
'PnYnMnDTnHnMnS').

@attr_reader [Time,nil] closed_at The time when the workflow execution

was closed.  Returns nil if this execution is not closed.

@attr_reader [Time] started_at The time when the execution was started.

@attr_reader [Time,nil] latest_activity_task_scheduled_at The time

when the last activity task was scheduled for this workflow execution.
You can use this information to determine if the workflow has not 
made progress for an unusually long period of time and might 
require a corrective action.

@attr_reader [String,nil] latest_execution_context The latest execution

context provided by the decider for this workflow execution. A decider 
can provide an execution context, which is a free form string, when 
closing a decision task.

@attr_reader [Hash] open_counts Returns a hash of counts, including:

+:open_timers+, +:open_child_workflow_executions+, +:open_decision_tasks+,
and +:open_activity_tasks+.

Attributes

domain[R]

@return [Domain] The domain this workflow execution was started in.

run_id[R]

@return [String] The run id of this execution.

workflow_id[R]

@return [String] The workflow id of this execution.

Public Class Methods

new(domain, workflow_id, run_id, options = {}) click to toggle source
Calls superclass method AWS::Core::Resource.new
# File lib/aws/simple_workflow/workflow_execution.rb, line 68
def initialize domain, workflow_id, run_id, options = {}
  @domain = domain
  @workflow_id = workflow_id
  @run_id = run_id
  super
end

Public Instance Methods

cancel_requested?() click to toggle source

@return [Boolean] Returns true if a request was made to cancel

this workflow execution.
# File lib/aws/simple_workflow/workflow_execution.rb, line 185
def cancel_requested?
  cancel_requested
end
closed?() click to toggle source

@return [Boolean] Returns true if the workflow execution is closed.

# File lib/aws/simple_workflow/workflow_execution.rb, line 195
def closed?
  !open?
end
count_executions(options = {}) click to toggle source

Counts the number of executions that share the same workflow id.

@note See {WorkflowExecutionCollection#count} for a broader count.

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

effort and may not exactly reflect recent updates and changes.

@param [Hash] options

@option options [Symbol] :status (:open) Specifies that

status of the workflow executions to count. Defaults to
open workflows.

* +:open+
* +:closed+

@option options [Array<Time>] :started_between A start and end time

to filter workflow execution start times by.  You may pass an 
array with two time values or a range.  Times should be
timestamps (integers), Time, Date, DateTime or parseable time 
strings. 

You may not pass both +:started_between+ and +:closed_between+.

@option options [Array<Time>] :closed_between A start and end time

to filter workflow execution closed times by.  You may pass an 
array with two time values or a range.  Times should be
timestamps (integers), Time, Date, DateTime or parseable time 
strings. 

You may not pass both +:started_between+ and +:closed_between+.
You may also not pass +:closed_between+ if the +:status+ is
+:open+.

@return [Integer] Returns the count of executions that share

workflow id with the current execution.
# File lib/aws/simple_workflow/workflow_execution.rb, line 366
def count_executions options = {}
  options[:workflow_id] = workflow_id
  domain.workflow_executions.count(options)
end
events()
Alias for: history_events
history_events() click to toggle source

@return [HistoryEventCollection] Returns a collection that enumerates

history events for this workflow execution.
# File lib/aws/simple_workflow/workflow_execution.rb, line 228
def history_events
  HistoryEventCollection.new(self)
end
Also aliased as: events
open?() click to toggle source

@return [Boolean] Returns true if the workflow execution is still open.

# File lib/aws/simple_workflow/workflow_execution.rb, line 190
def open?
  status == :open
end
open_activity_task_count() click to toggle source

@return [Integer] Returns the number of open activity tasks.

# File lib/aws/simple_workflow/workflow_execution.rb, line 206
def open_activity_task_count
  open_counts[:open_activity_tasks]
end
open_child_workflow_execution_count() click to toggle source

@return [Boolean] Returns true if this workflow execution has an

open decision task.
# File lib/aws/simple_workflow/workflow_execution.rb, line 201
def open_child_workflow_execution_count
  open_counts[:open_child_workflow_executions]
end
open_decision_task_count() click to toggle source

@return [Integer] Returns the number of closed activity tasks.

# File lib/aws/simple_workflow/workflow_execution.rb, line 216
def open_decision_task_count
  open_counts[:open_decision_tasks]
end
open_timer_count() click to toggle source

@return [Integer] Returns the number of open timers.

# File lib/aws/simple_workflow/workflow_execution.rb, line 211
def open_timer_count
  open_counts[:open_timers]
end
parent() click to toggle source

@return [WorkflowExecution,nil] Returns the parent workflow execution

(if there is one).
# File lib/aws/simple_workflow/workflow_execution.rb, line 241
def parent
  if parent = self.parent_details
    domain.workflow_executions[parent['workflowId'],parent['runId']]
  else
    nil
  end
end
request_cancel() click to toggle source

Records a WorkflowExecutionCancelRequested event in the currently running workflow execution. This logically requests the cancellation of the workflow execution as a whole. It is up to the decider to take appropriate actions when it receives an execution history with this event.

@note Because this action allows the workflow to properly clean up

and gracefully close, it should be used instead of {#terminate}
when possible.

@return [nil]

# File lib/aws/simple_workflow/workflow_execution.rb, line 282
def request_cancel
  options = { :run_id => run_id }
  domain.workflow_executions.request_cancel(workflow_id, options)
end
signal(signal_name, options = {}) click to toggle source

Records a WorkflowExecutionSignaled event in the workflow execution history and creates a decision task for the workflow execution.

workflow_execution.signal('signal_name', :input => '...')

@param [String] signal_name The name of the signal. This name must be

meaningful to the target workflow.

@param [Hash] options

@option options [String] :input (nil) Data to attach to the

WorkflowExecutionSignaled event in the target workflow 
execution's history.

@return [nil]

# File lib/aws/simple_workflow/workflow_execution.rb, line 265
def signal signal_name, options = {}
  options[:run_id] = run_id
  domain.workflow_executions.signal(workflow_id, signal_name, options)
end
status() click to toggle source

@return [Symbol] Returns the status of this execution. Possible

return values are:

* +:open+ - The execution is still running.
* +:completed+ - The execution was successfully completed.
* +:canceled+ - The execution was canceled, cancellation allows 
   the implementation to gracefully clean up before the execution 
   is closed.
* +:failed+ - The execution failed to complete.
  and was automatically timed out.
* +:continued_as_new+ - The execution is logically continued. This
  means the current execution was completed and a new execution 
  was started to carry on the workflow.
* +:terminated+ - The execution was force terminated.
* +:timed_out+ - The execution did not complete in the allotted
  time and was automatically timed out.
# File lib/aws/simple_workflow/workflow_execution.rb, line 177
def status
  AWS.memoize do
    execution_status == :open ? :open : (close_status || :closed)
  end
end
tags() click to toggle source

@return [Array<String>] Returns an array of tags assigned to this

execution.
# File lib/aws/simple_workflow/workflow_execution.rb, line 222
def tags
  tag_list || []
end
terminate(options = {}) click to toggle source

Records a WorkflowExecutionTerminated event and forces closure of the workflow execution. The child policy, registered with the workflow type or specified when starting this execution, is applied to any open child workflow executions of this workflow execution.

@note If the workflow execution was in progress, it is terminated

immediately.

@note You should consider canceling the workflow execution

instead because it allows the workflow to gracefully close
while terminate does not.

@param [Hash] options

@option options [Symbol] :child_policy (nil)

If set, specifies the policy to use for the child workflow 
executions of the workflow execution being terminated. This 
policy overrides the default child policy.  Valid policies include:

* +:terminate+ - the child executions will be terminated.

* +:request_cancel+ - a request to cancel will be attempted for each
  child execution by recording a WorkflowExecutionCancelRequested 
  event in its history. It is up to the decider to take appropriate
  actions when it receives an execution history with this event.

* +:abandon+ - no action will be taken. The child executions will 
  continue to run.

@option options [String] :details (nil) Optional details for

terminating the workflow execution.

@option options [String] :reason (nil) An optional descriptive

reason for terminating the workflow execution.

@return [nil]

# File lib/aws/simple_workflow/workflow_execution.rb, line 324
def terminate options = {}
  options[:run_id] = run_id
  domain.workflow_executions.terminate(workflow_id, options)
end
workflow_type() click to toggle source

@return [WorkflowType] Returns the type of this workflow execution.

# File lib/aws/simple_workflow/workflow_execution.rb, line 234
def workflow_type
  type = self.type_details
  WorkflowType.new(domain, type['name'], type['version'])
end

Protected Instance Methods

resource_identifiers() click to toggle source
# File lib/aws/simple_workflow/workflow_execution.rb, line 372
def resource_identifiers
  [[:domain,domain.name], [:workflow_id,workflow_id], [:run_id,run_id]]
end
resource_options() click to toggle source
# File lib/aws/simple_workflow/workflow_execution.rb, line 377
def resource_options
  {
    :domain => domain.name,
    :execution => { :workflow_id => workflow_id, :run_id => run_id },
  }
end