Class: Temporalio::Workflow::ExternalWorkflowHandle

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

Overview

Handle for interacting with an external workflow.

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

Instance Method Summary collapse

Instance Method Details

#cancel ⇒ Object

Cancel the external workflow.

Raises:

  • (NotImplementedError) 


38
39
40
 
# File 'lib/temporalio/workflow/external_workflow_handle.rb', line 38

def cancel
  raise NotImplementedError
end

#id ⇒ String

Returns ID for the workflow.

Returns:

  • (String) —

    ID for the workflow.

Raises:

  • (NotImplementedError) 


17
18
19
 
# File 'lib/temporalio/workflow/external_workflow_handle.rb', line 17

def id
  raise NotImplementedError
end

#run_id ⇒ String?

Returns Run ID for the workflow.

Returns:

  • (String, nil) —

    Run ID for the workflow.

Raises:

  • (NotImplementedError) 


22
23
24
 
# File 'lib/temporalio/workflow/external_workflow_handle.rb', line 22

def run_id
  raise NotImplementedError
end

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

Signal the external 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) 


33
34
35
 
# File 'lib/temporalio/workflow/external_workflow_handle.rb', line 33

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