Class: AWS::Flow::WorkflowFuture

Inherits:
Object
  • Object
show all
Defined in:
lib/aws/decider/workflow_client.rb

Overview

A future provided by a [WorkflowExecution](docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/WorkflowExecution.html).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(workflow_execution) ⇒ WorkflowFuture

Creates a new workflow future

Parameters:

  • workflow_execution 


37
38
39
40
 
# File 'lib/aws/decider/workflow_client.rb', line 37

def initialize(workflow_execution)
  @_workflow_execution = workflow_execution
  @return_value = Future.new
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args, &block) ⇒ Object 



48
49
50
 
# File 'lib/aws/decider/workflow_client.rb', line 48

def method_missing(method_name, *args, &block)
  @return_value.send(method_name, *args, &block)
end

Instance Attribute Details

#_workflow_execution ⇒ Object

The [WorkflowExecution](docs.aws.amazon.com/AWSRubySDK/latest/AWS/SimpleWorkflow/WorkflowExecution.html) instance that this future belongs to.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/aws/decider/workflow_client.rb', line 29

class WorkflowFuture
  attr_accessor :_workflow_execution, :return_value


  # Creates a new workflow future
  #
  # @param workflow_execution
  #
  def initialize(workflow_execution)
    @_workflow_execution = workflow_execution
    @return_value = Future.new
  end

  # determines whether the object is a flow future. The contract is that
  # flow futures must have a #get method.
  def is_flow_future?
    true
  end

  def method_missing(method_name, *args, &block)
    @return_value.send(method_name, *args, &block)
  end


  # Gets the current value of the workflow execution
  # @return
  def workflow_execution
    @_workflow_execution
  end
end

#return_value ⇒ Object

The return value of the future.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/aws/decider/workflow_client.rb', line 29

class WorkflowFuture
  attr_accessor :_workflow_execution, :return_value


  # Creates a new workflow future
  #
  # @param workflow_execution
  #
  def initialize(workflow_execution)
    @_workflow_execution = workflow_execution
    @return_value = Future.new
  end

  # determines whether the object is a flow future. The contract is that
  # flow futures must have a #get method.
  def is_flow_future?
    true
  end

  def method_missing(method_name, *args, &block)
    @return_value.send(method_name, *args, &block)
  end


  # Gets the current value of the workflow execution
  # @return
  def workflow_execution
    @_workflow_execution
  end
end

Instance Method Details

#is_flow_future? ⇒ Boolean

determines whether the object is a flow future. The contract is that flow futures must have a #get method.

Returns:

  • (Boolean) 


44
45
46
 
# File 'lib/aws/decider/workflow_client.rb', line 44

def is_flow_future?
  true
end

#workflow_execution ⇒ Object

Gets the current value of the workflow execution

Returns:



55
56
57
 
# File 'lib/aws/decider/workflow_client.rb', line 55

def workflow_execution
  @_workflow_execution
end