Class: Temporalio::Client::WorkflowUpdateHandle

Inherits:
Object
  • Object
show all
Defined in:
lib/temporalio/client/workflow_update_handle.rb

Overview

Handle for a workflow update execution request. This is usually created via Temporalio::Client::WorkflowHandle#start_update or Temporalio::Client::WorkflowHandle#update_handle.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#id ⇒ String (readonly)

Returns ID for the workflow update.

Returns:

  • (String) —

    ID for the workflow update.



13
14
15
 
# File 'lib/temporalio/client/workflow_update_handle.rb', line 13

def id
  @id
end

#result_hint ⇒ Object? (readonly)

Returns Result hint if one set when the handle was created.

Returns:

  • (Object, nil) —

    Result hint if one set when the handle was created.



22
23
24
 
# File 'lib/temporalio/client/workflow_update_handle.rb', line 22

def result_hint
  @result_hint
end

#workflow_id ⇒ String (readonly)

Returns ID for the workflow.

Returns:

  • (String) —

    ID for the workflow.



16
17
18
 
# File 'lib/temporalio/client/workflow_update_handle.rb', line 16

def workflow_id
  @workflow_id
end

#workflow_run_id ⇒ String? (readonly)

Returns Run ID for the workflow.

Returns:

  • (String, nil) —

    Run ID for the workflow.



19
20
21
 
# File 'lib/temporalio/client/workflow_update_handle.rb', line 19

def workflow_run_id
  @workflow_run_id
end

Instance Method Details

#result(result_hint: nil, rpc_options: nil) ⇒ Object?

Wait for and return the result of the update. The result may already be known in which case no network call is made. Otherwise the result will be polled for until it is returned.

Parameters:

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

    If not nil, overrides handle-level result hint for getting the result.

  • rpc_options (RPCOptions, nil) (defaults to: nil) —

    Advanced RPC options.

Returns:

  • (Object, nil) —

    Update result.

Raises:



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/temporalio/client/workflow_update_handle.rb', line 52

def result(result_hint: nil, rpc_options: nil)
  @known_outcome ||= @client._impl.poll_workflow_update(Interceptor::PollWorkflowUpdateInput.new(
                                                          workflow_id:,
                                                          run_id: workflow_run_id,
                                                          update_id: id,
                                                          rpc_options:
                                                        ))

  if @known_outcome.failure
    raise Error::WorkflowUpdateFailedError.new, cause: @client.data_converter.from_failure(@known_outcome.failure)
  end

  results = @client.data_converter.from_payloads(@known_outcome.success,
                                                 hints: Array(result_hint || @result_hint))
  warn("Expected 0 or 1 update result, got #{results.size}") if results.size > 1
  results.first
end

#result_obtained? ⇒ Boolean

Returns True if the result is already known and #result will not make a blocking call, false if #result will make a blocking call because the result is not yet known.

Returns:

  • (Boolean) —

    True if the result is already known and #result will not make a blocking call, false if #result will make a blocking call because the result is not yet known.



36
37
38
 
# File 'lib/temporalio/client/workflow_update_handle.rb', line 36

def result_obtained?
  !@known_outcome.nil?
end