Class: Temporalio::Workflow::ChildWorkflowHandle

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/workflow/child_workflow_handle.rb

Overview

Handle for interacting with a child workflow.

This is created via start_child_workflow, it is never instantiated directly.

Instance Method Summary collapse

Instance Method Details

#first_execution_run_id ⇒ String

Returns Run ID for the workflow.

Returns:

  • (String) —

    Run ID for the workflow.

Raises:

  • (NotImplementedError) 


20
21
22
 
# File 'lib/temporalio/workflow/child_workflow_handle.rb', line 20

def first_execution_run_id
  raise NotImplementedError
end

#id ⇒ String

Returns ID for the workflow.

Returns:

  • (String) —

    ID for the workflow.

Raises:

  • (NotImplementedError) 


15
16
17
 
# File 'lib/temporalio/workflow/child_workflow_handle.rb', line 15

def id
  raise NotImplementedError
end

#result(result_hint: nil) ⇒ Object

Wait for the result.

Parameters:

  • result_hint (Object, nil) (defaults to: nil) —

    Override the result hint, or if nil uses the one on the handle.

Returns:

  • (Object) —

    Result of the child workflow.

Raises:



35
36
37
 
# File 'lib/temporalio/workflow/child_workflow_handle.rb', line 35

def result(result_hint: nil)
  raise NotImplementedError
end

#result_hint ⇒ Object?

Returns Hint for the result if any.

Returns:

  • (Object, nil) —

    Hint for the result if any.

Raises:

  • (NotImplementedError) 


25
26
27
 
# File 'lib/temporalio/workflow/child_workflow_handle.rb', line 25

def result_hint
  raise NotImplementedError
end

#signal(signal, *args, cancellation: Workflow.cancellation, arg_hints: nil) ⇒ Object

Signal the child workflow.

Parameters:

  • signal (Workflow::Definition::Signal, Symbol, String) —

    Signal definition or name.

  • args (Array<Object>) —

    Signal args.

  • cancellation (Cancellation) (defaults to: Workflow.cancellation) —

    Cancellation for canceling the signalling.

  • arg_hints (Array<Object>, nil) (defaults to: nil) —

    Overrides converter hints for arguments if any. If unset/nil and the signal definition has arg hints, those are used by default.

Raises:

  • (NotImplementedError) 


46
47
48
 
# File 'lib/temporalio/workflow/child_workflow_handle.rb', line 46

def signal(signal, *args, cancellation: Workflow.cancellation, arg_hints: nil)
  raise NotImplementedError
end