Class: AWS::Flow::SignalWorkflowOptions

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

Overview

Options for WorkflowClient#signal_workflow_execution.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Options

#get_options, inherited, #initialize, #method_missing

Constructor Details

This class inherits a constructor from AWS::Flow::Options

Dynamic Method Handling

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

Instance Attribute Details

#control ⇒ Object

Optional data attached to the signal that can be used by the workflow execution.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws/decider/options.rb', line 138

class SignalWorkflowOptions < Options
  properties(:input, :signal_name, :run_id, :workflow_id, :control, :domain)

  # Gets a hash containing the held options.
  def get_full_options
    result = {}
    SignalWorkflowOptions.held_properties.each do |option|
      result[option] = self.send(option) if self.send(option) && self.send(option) != ""
    end
    result
  end
end

#domain ⇒ Object

Required. The name of the domain containing the workflow execution to signal.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws/decider/options.rb', line 138

class SignalWorkflowOptions < Options
  properties(:input, :signal_name, :run_id, :workflow_id, :control, :domain)

  # Gets a hash containing the held options.
  def get_full_options
    result = {}
    SignalWorkflowOptions.held_properties.each do |option|
      result[option] = self.send(option) if self.send(option) && self.send(option) != ""
    end
    result
  end
end

#input ⇒ Object

Data to attach to the WorkflowExecutionSignaled event in the target workflow execution’s history.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws/decider/options.rb', line 138

class SignalWorkflowOptions < Options
  properties(:input, :signal_name, :run_id, :workflow_id, :control, :domain)

  # Gets a hash containing the held options.
  def get_full_options
    result = {}
    SignalWorkflowOptions.held_properties.each do |option|
      result[option] = self.send(option) if self.send(option) && self.send(option) != ""
    end
    result
  end
end

#run_id ⇒ Object

The runId of the workflow execution to signal.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws/decider/options.rb', line 138

class SignalWorkflowOptions < Options
  properties(:input, :signal_name, :run_id, :workflow_id, :control, :domain)

  # Gets a hash containing the held options.
  def get_full_options
    result = {}
    SignalWorkflowOptions.held_properties.each do |option|
      result[option] = self.send(option) if self.send(option) && self.send(option) != ""
    end
    result
  end
end

#signal_name ⇒ Object

Required. The name of the signal. This name must be meaningful to the target workflow.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws/decider/options.rb', line 138

class SignalWorkflowOptions < Options
  properties(:input, :signal_name, :run_id, :workflow_id, :control, :domain)

  # Gets a hash containing the held options.
  def get_full_options
    result = {}
    SignalWorkflowOptions.held_properties.each do |option|
      result[option] = self.send(option) if self.send(option) && self.send(option) != ""
    end
    result
  end
end

#workflow_id ⇒ Object

Required. The workflowId of the workflow execution to signal.



138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/aws/decider/options.rb', line 138

class SignalWorkflowOptions < Options
  properties(:input, :signal_name, :run_id, :workflow_id, :control, :domain)

  # Gets a hash containing the held options.
  def get_full_options
    result = {}
    SignalWorkflowOptions.held_properties.each do |option|
      result[option] = self.send(option) if self.send(option) && self.send(option) != ""
    end
    result
  end
end

Instance Method Details

#get_full_options ⇒ Object

Gets a hash containing the held options.



142
143
144
145
146
147
148
 
# File 'lib/aws/decider/options.rb', line 142

def get_full_options
  result = {}
  SignalWorkflowOptions.held_properties.each do |option|
    result[option] = self.send(option) if self.send(option) && self.send(option) != ""
  end
  result
end