Module: Temporalio::Worker::Interceptor::Workflow

Included in:

Contrib::OpenTelemetry::TracingInterceptor

Defined in:

lib/temporalio/worker/interceptor.rb

Overview

Note:

Input classes herein may get new required fields added and therefore the constructors of the Input classes may change in backwards incompatible ways. Users should not try to construct Input classes themselves.

Mixin for intercepting workflow worker work. Classes that ‘include` may implement their own #intercept_workflow that returns their own instance of Inbound.

Defined Under Namespace

Classes: Inbound, Outbound

Constant Summary

ExecuteInput =

Input for Inbound#execute.

Data.define(
  :args,
  :headers
)

HandleSignalInput =

Input for Inbound#handle_signal.

Data.define(
  :signal,
  :args,
  :definition,
  :headers
)

HandleQueryInput =

Input for Inbound#handle_query.

Data.define(
  :id,
  :query,
  :args,
  :definition,
  :headers
)

HandleUpdateInput =

Input for Inbound#validate_update and Inbound#handle_update.

Data.define(
  :id,
  :update,
  :args,
  :definition,
  :headers
)

CancelExternalWorkflowInput =

Input for Outbound#cancel_external_workflow.

Data.define(
  :id,
  :run_id
)

ExecuteActivityInput =

Input for Outbound#execute_activity.

Data.define(
  :activity,
  :args,
  :task_queue,
  :summary,
  :schedule_to_close_timeout,
  :schedule_to_start_timeout,
  :start_to_close_timeout,
  :heartbeat_timeout,
  :retry_policy,
  :cancellation,
  :cancellation_type,
  :activity_id,
  :disable_eager_execution,
  :headers
)

ExecuteLocalActivityInput =

Input for Outbound#execute_local_activity.

Data.define(
  :activity,
  :args,
  :schedule_to_close_timeout,
  :schedule_to_start_timeout,
  :start_to_close_timeout,
  :retry_policy,
  :local_retry_threshold,
  :cancellation,
  :cancellation_type,
  :activity_id,
  :headers
)

InitializeContinueAsNewErrorInput =

Input for Outbound#initialize_continue_as_new_error.

Data.define(
  :error
)

SignalChildWorkflowInput =

Input for Outbound#signal_child_workflow.

Data.define(
  :id,
  :signal,
  :args,
  :cancellation,
  :headers
)

SignalExternalWorkflowInput =

Input for Outbound#signal_external_workflow.

Data.define(
  :id,
  :run_id,
  :signal,
  :args,
  :cancellation,
  :headers
)

SleepInput =

Input for Outbound#sleep.

Data.define(
  :duration,
  :summary,
  :cancellation
)

StartChildWorkflowInput =

Input for Outbound#start_child_workflow.

Data.define(
  :workflow,
  :args,
  :id,
  :task_queue,
  :static_summary,
  :static_details,
  :cancellation,
  :cancellation_type,
  :parent_close_policy,
  :execution_timeout,
  :run_timeout,
  :task_timeout,
  :id_reuse_policy,
  :retry_policy,
  :cron_schedule,
  :memo,
  :search_attributes,
  :headers
)

Instance Method Summary

• #intercept_workflow(next_interceptor) ⇒ Inbound

  Method called when intercepting a workflow.

Instance Method Details

#intercept_workflow(next_interceptor) ⇒ Inbound

Method called when intercepting a workflow. This is called when creating a workflow instance.

Parameters:

• next_interceptor (Inbound) —

  Next interceptor in the chain that should be called. This is usually passed to Inbound constructor.

Returns:

• (Inbound) —

  Interceptor to be called for workflow calls.

# File 'lib/temporalio/worker/interceptor.rb', line 98

def intercept_workflow(next_interceptor)
  next_interceptor
end