Class: Temporalio::Client::ActivityHandle

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

Overview

Handle for interacting with a standalone activity. Usually created via #activity_handle or #start_activity.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#id ⇒ String (readonly)

Returns ID for the activity.

Returns:

  • (String) —

    ID for the activity.



14
15
16
 
# File 'lib/temporalio/client/activity_handle.rb', line 14

def id
  @id
end

#result_hint ⇒ Object? (readonly)

Returns Result hint used when deserializing the activity's result. May be overridden per #result call.

Returns:

  • (Object, nil) —

    Result hint used when deserializing the activity's result. May be overridden per #result call.



21
22
23
 
# File 'lib/temporalio/client/activity_handle.rb', line 21

def result_hint
  @result_hint
end

#run_id ⇒ String? (readonly)

Returns Run ID for this activity execution. When nil, this handle targets the latest run.

Returns:

  • (String, nil) —

    Run ID for this activity execution. When nil, this handle targets the latest run.



17
18
19
 
# File 'lib/temporalio/client/activity_handle.rb', line 17

def run_id
  @run_id
end

Instance Method Details

#cancel(reason = nil, rpc_options: nil) ⇒ Object

Request cancellation of the activity.

Parameters:

  • reason (String, nil) (defaults to: nil) —

    Optional cancellation reason recorded on the server.

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

    Advanced RPC options.

Raises:



75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/temporalio/client/activity_handle.rb', line 75

def cancel(reason = nil, rpc_options: nil)
  @client._impl.cancel_activity(
    Interceptor::CancelActivityInput.new(
      activity_id: id,
      activity_run_id: run_id,
      reason:,
      rpc_options:
    )
  )
  nil
end

#describe(rpc_options: nil) ⇒ ActivityExecution::Description

Describe the activity.

Parameters:

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

    Advanced RPC options.

Returns:

Raises:



60
61
62
63
64
65
66
67
68
 
# File 'lib/temporalio/client/activity_handle.rb', line 60

def describe(rpc_options: nil)
  @client._impl.describe_activity(
    Interceptor::DescribeActivityInput.new(
      activity_id: id,
      activity_run_id: run_id,
      rpc_options:
    )
  )
end

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

Wait for the activity's outcome (result or failure). Internally long-polls PollActivityExecution and reissues until the activity reaches a terminal state, so this can block indefinitely for long-running activities.

Parameters:

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

    Override the result hint. If nil, uses #result_hint.

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

    Advanced RPC options.

Returns:

  • (Object, nil) —

    Deserialized activity result.

Raises:



42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/temporalio/client/activity_handle.rb', line 42

def result(result_hint: nil, rpc_options: nil)
  hint = result_hint || @result_hint
  outcome = @client._impl.fetch_activity_outcome(
    Interceptor::FetchActivityOutcomeInput.new(
      activity_id: id,
      activity_run_id: run_id,
      rpc_options:
    )
  )
  _process_outcome(outcome, hint)
end

#terminate(reason = nil, rpc_options: nil) ⇒ Object

Terminate the activity (force-close).

Parameters:

  • reason (String, nil) (defaults to: nil) —

    Optional termination reason recorded on the activity's failure outcome.

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

    Advanced RPC options.

Raises:



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/temporalio/client/activity_handle.rb', line 92

def terminate(reason = nil, rpc_options: nil)
  @client._impl.terminate_activity(
    Interceptor::TerminateActivityInput.new(
      activity_id: id,
      activity_run_id: run_id,
      reason:,
      rpc_options:
    )
  )
  nil
end