Class: Temporalio::Workflow::NexusOperationHandle

Inherits:

Object

• Object
• Temporalio::Workflow::NexusOperationHandle

Defined in:

lib/temporalio/workflow/nexus_operation_handle.rb

Overview

Handle for interacting with a Nexus operation.

This is created via Temporalio::Workflow::NexusClient#start_operation, it is never instantiated directly.

WARNING: Nexus support is experimental.

Direct Known Subclasses

Internal::Worker::WorkflowInstance::NexusOperationHandle

Instance Method Summary

• #operation_token ⇒ String^?

  Operation token for async operations, nil for sync operations.

• #result(result_hint: nil) ⇒ Object

  Wait for the result.

• #result_hint ⇒ Object^?

  Hint for the result if any.

Instance Method Details

#operation_token ⇒ String^?

Returns Operation token for async operations, nil for sync operations.

Returns:

• (String, nil) —

  Operation token for async operations, nil for sync operations.

Raises:

• (NotImplementedError)

# File 'lib/temporalio/workflow/nexus_operation_handle.rb', line 17

def operation_token
  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 Nexus operation.

Raises:

• (Error::NexusOperationError) —

  Operation failed with cause as the cause.

# File 'lib/temporalio/workflow/nexus_operation_handle.rb', line 32

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)

# File 'lib/temporalio/workflow/nexus_operation_handle.rb', line 22

def result_hint
  raise NotImplementedError
end