Module: Temporalio::Client::Interceptor

Defined in:

lib/temporalio/client/interceptor.rb

Overview

Note:

Input classes herein may get new required fields added and therefore the constructors of the Input classes

Mixin for intercepting clients. Classes that include this should implement their own #intercept_client that returns their own instance of Outbound.

may change in backwards incompatible ways. Users should not try to construct Input classes themselves.

Defined Under Namespace

Classes: Outbound

Constant Summary

StartWorkflowInput =

Input for Outbound#start_workflow.

Data.define(
  :workflow,
  :args,
  :workflow_id,
  :task_queue,
  :static_summary,
  :static_details,
  :execution_timeout,
  :run_timeout,
  :task_timeout,
  :id_reuse_policy,
  :id_conflict_policy,
  :retry_policy,
  :cron_schedule,
  :memo,
  :search_attributes,
  :start_delay,
  :request_eager_start,
  :headers,
  :rpc_options
)

StartUpdateWithStartWorkflowInput =

Input for Outbound#start_update_with_start_workflow.

Data.define(
  :update_id,
  :update,
  :args,
  :wait_for_stage,
  :start_workflow_operation,
  :headers,
  :rpc_options
)

SignalWithStartWorkflowInput =

Input for Outbound#signal_with_start_workflow.

Data.define(
  :signal,
  :args,
  :start_workflow_operation,
  # Headers intentionally not defined here, because they are not separate from start_workflow_operation
  :rpc_options
)

ListWorkflowsInput =

Input for Outbound#list_workflows.

Data.define(
  :query,
  :rpc_options
)

CountWorkflowsInput =

Input for Outbound#count_workflows.

Data.define(
  :query,
  :rpc_options
)

DescribeWorkflowInput =

Input for Outbound#describe_workflow.

Data.define(
  :workflow_id,
  :run_id,
  :rpc_options
)

FetchWorkflowHistoryEventsInput =

Input for Outbound#fetch_workflow_history_events.

Data.define(
  :workflow_id,
  :run_id,
  :wait_new_event,
  :event_filter_type,
  :skip_archival,
  :rpc_options
)

SignalWorkflowInput =

Input for Outbound#signal_workflow.

Data.define(
  :workflow_id,
  :run_id,
  :signal,
  :args,
  :headers,
  :rpc_options
)

QueryWorkflowInput =

Input for Outbound#query_workflow.

Data.define(
  :workflow_id,
  :run_id,
  :query,
  :args,
  :reject_condition,
  :headers,
  :rpc_options
)

StartWorkflowUpdateInput =

Input for Outbound#start_workflow_update.

Data.define(
  :workflow_id,
  :run_id,
  :update_id,
  :update,
  :args,
  :wait_for_stage,
  :headers,
  :rpc_options
)

PollWorkflowUpdateInput =

Input for Outbound#poll_workflow_update.

Data.define(
  :workflow_id,
  :run_id,
  :update_id,
  :rpc_options
)

CancelWorkflowInput =

Input for Outbound#cancel_workflow.

Data.define(
  :workflow_id,
  :run_id,
  :first_execution_run_id,
  :rpc_options
)

TerminateWorkflowInput =

Input for Outbound#terminate_workflow.

Data.define(
  :workflow_id,
  :run_id,
  :first_execution_run_id,
  :reason,
  :details,
  :rpc_options
)

CreateScheduleInput =

Input for Outbound#create_schedule.

Data.define(
  :id,
  :schedule,
  :trigger_immediately,
  :backfills,
  :memo,
  :search_attributes,
  :rpc_options
)

ListSchedulesInput =

Input for Outbound#list_schedules.

Data.define(
  :query,
  :rpc_options
)

BackfillScheduleInput =

Input for Outbound#backfill_schedule.

Data.define(
  :id,
  :backfills,
  :rpc_options
)

DeleteScheduleInput =

Input for Outbound#delete_schedule.

Data.define(
  :id,
  :rpc_options
)

DescribeScheduleInput =

Input for Outbound#describe_schedule.

Data.define(
  :id,
  :rpc_options
)

PauseScheduleInput =

Input for Outbound#pause_schedule.

Data.define(
  :id,
  :note,
  :rpc_options
)

TriggerScheduleInput =

Input for Outbound#trigger_schedule.

Data.define(
  :id,
  :overlap,
  :rpc_options
)

UnpauseScheduleInput =

Input for Outbound#unpause_schedule.

Data.define(
  :id,
  :note,
  :rpc_options
)

UpdateScheduleInput =

Input for Outbound#update_schedule.

Data.define(
  :id,
  :updater,
  :rpc_options
)

HeartbeatAsyncActivityInput =

Input for Outbound#heartbeat_async_activity.

Data.define(
  :task_token_or_id_reference,
  :details,
  :rpc_options
)

CompleteAsyncActivityInput =

Input for Outbound#complete_async_activity.

Data.define(
  :task_token_or_id_reference,
  :result,
  :rpc_options
)

FailAsyncActivityInput =

Input for Outbound#fail_async_activity.

Data.define(
  :task_token_or_id_reference,
  :error,
  :last_heartbeat_details,
  :rpc_options
)

ReportCancellationAsyncActivityInput =

Input for Outbound#report_cancellation_async_activity.

Data.define(
  :task_token_or_id_reference,
  :details,
  :rpc_options
)

Instance Method Summary

• #intercept_client(next_interceptor) ⇒ Outbound

  Method called when intercepting a client.

Instance Method Details

#intercept_client(next_interceptor) ⇒ Outbound

Method called when intercepting a client. This is called upon client creation.

Parameters:

• next_interceptor (Outbound) —

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

Returns:

• (Outbound) —

  Interceptor to be called for client calls.

# File 'lib/temporalio/client/interceptor.rb', line 16

def intercept_client(next_interceptor)
  next_interceptor
end