Class: Temporalio::Client::Interceptor::Outbound

Inherits:

Object

Object
Temporalio::Client::Interceptor::Outbound

show all

Defined in:: lib/temporalio/client/interceptor.rb

Overview

Outbound interceptor for intercepting client calls. This should be extended by users needing to intercept client actions.

Direct Known Subclasses

Internal::Client::Implementation

Instance Attribute Summary collapse

#next_interceptor ⇒ Outbound readonly

Next interceptor in the chain.

Instance Method Summary collapse

#backfill_schedule(input) ⇒ Object

Called for every ScheduleHandle#backfill call.
#cancel_workflow(input) ⇒ Object

Called for every WorkflowHandle#cancel call.
#complete_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#complete call.
#count_workflows(input) ⇒ WorkflowExecutionCount

Called for every Temporalio::Client#count_workflows call.
#create_schedule(input) ⇒ ScheduleHandle

Called for every Temporalio::Client#create_schedule call.
#delete_schedule(input) ⇒ Object

Called for every ScheduleHandle#delete call.
#describe_schedule(input) ⇒ Schedule::Description

Called for every ScheduleHandle#describe call.
#describe_workflow(input) ⇒ WorkflowExecution::Description

Called for every WorkflowHandle#describe call.
#fail_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#fail call.
#fetch_workflow_history_events(input) ⇒ Enumerator<Api::History::V1::HistoryEvent>

Called everytime the client needs workflow history.
#heartbeat_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#heartbeat call.
#initialize(next_interceptor) ⇒ Outbound constructor

Initialize outbound with the next interceptor in the chain.
#list_schedules(input) ⇒ Enumerator<Schedule::List::Description>

Called for every Temporalio::Client#list_schedules call.
#list_workflows(input) ⇒ Enumerator<WorkflowExecution>

Called for every Temporalio::Client#list_workflows call.
#pause_schedule(input) ⇒ Object

Called for every ScheduleHandle#pause call.
#poll_workflow_update(input) ⇒ Api::Update::V1::Outcome

Called when polling for update result.
#query_workflow(input) ⇒ Object^?

Called for every WorkflowHandle#query call.
#report_cancellation_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#report_cancellation call.
#signal_with_start_workflow(input) ⇒ WorkflowHandle

Called for every Temporalio::Client#signal_with_start_workflow.
#signal_workflow(input) ⇒ Object

Called for every WorkflowHandle#signal call.
#start_update_with_start_workflow(input) ⇒ WorkflowUpdateHandle

Called for every Temporalio::Client#start_update_with_start_workflow and Temporalio::Client#execute_update_with_start_workflow call.
#start_workflow(input) ⇒ WorkflowHandle

Called for every Temporalio::Client#start_workflow and Temporalio::Client#execute_workflow call.
#start_workflow_update(input) ⇒ WorkflowUpdateHandle

Called for every WorkflowHandle#start_update call.
#terminate_workflow(input) ⇒ Object

Called for every WorkflowHandle#terminate call.
#trigger_schedule(input) ⇒ Object

Called for every ScheduleHandle#trigger call.
#unpause_schedule(input) ⇒ Object

Called for every ScheduleHandle#unpause call.
#update_schedule(input) ⇒ Object

Called for every ScheduleHandle#update call.

Constructor Details

#initialize(next_interceptor) ⇒ `Outbound`

Initialize outbound with the next interceptor in the chain.

Parameters:

next_interceptor (Outbound) —

Next interceptor in the chain.



255
256
257

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

def initialize(next_interceptor)
  @next_interceptor = next_interceptor
end

Instance Attribute Details

#next_interceptor ⇒ `Outbound` (readonly)

Returns Next interceptor in the chain.

Returns:

(Outbound) —

Next interceptor in the chain.



250
251
252

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

def next_interceptor
  @next_interceptor
end

Instance Method Details

#backfill_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#backfill call.

Parameters:

input (BackfillScheduleInput) —

Input.



380
381
382

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

def backfill_schedule(input)
  next_interceptor.backfill_schedule(input)
end

#cancel_workflow(input) ⇒ `Object`

Called for every WorkflowHandle#cancel call.

Parameters:

input (CancelWorkflowInput) —

Input.



350
351
352

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

def cancel_workflow(input)
  next_interceptor.cancel_workflow(input)
end

#complete_async_activity(input) ⇒ `Object`

Called for every AsyncActivityHandle#complete call.

Parameters:

input (CompleteAsyncActivityInput) —

Input.



437
438
439

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

def complete_async_activity(input)
  next_interceptor.complete_async_activity(input)
end

#count_workflows(input) ⇒ `WorkflowExecutionCount`

Called for every Temporalio::Client#count_workflows call.

Parameters:

input (CountWorkflowsInput) —

Input.

Returns:

(WorkflowExecutionCount) —

Workflow count.



296
297
298

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

def count_workflows(input)
  next_interceptor.count_workflows(input)
end

#create_schedule(input) ⇒ `ScheduleHandle`

Called for every Temporalio::Client#create_schedule call.

Parameters:

input (CreateScheduleInput) —

Input.

Returns:

(ScheduleHandle) —

Schedule handle.



365
366
367

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

def create_schedule(input)
  next_interceptor.create_schedule(input)
end

#delete_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#delete call.

Parameters:

input (DeleteScheduleInput) —

Input.



387
388
389

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

def delete_schedule(input)
  next_interceptor.delete_schedule(input)
end

#describe_schedule(input) ⇒ `Schedule::Description`

Called for every ScheduleHandle#describe call.

Parameters:

input (DescribeScheduleInput) —

Input.

Returns:

(Schedule::Description) —

Schedule description.



395
396
397

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

def describe_schedule(input)
  next_interceptor.describe_schedule(input)
end

#describe_workflow(input) ⇒ `WorkflowExecution::Description`

Called for every WorkflowHandle#describe call.

Parameters:

input (DescribeWorkflowInput) —

Input.

Returns:

(WorkflowExecution::Description) —

Workflow description.



304
305
306

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

def describe_workflow(input)
  next_interceptor.describe_workflow(input)
end

#fail_async_activity(input) ⇒ `Object`

Called for every AsyncActivityHandle#fail call.

Parameters:

input (FailAsyncActivityInput) —

Input.



444
445
446

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

def fail_async_activity(input)
  next_interceptor.fail_async_activity(input)
end

#fetch_workflow_history_events(input) ⇒ `Enumerator<Api::History::V1::HistoryEvent>`

Called everytime the client needs workflow history. This includes getting the result.

Parameters:

input (FetchWorkflowHistoryEventsInput) —

Input.

Returns:

(Enumerator<Api::History::V1::HistoryEvent>) —

Event enumerator.



312
313
314

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

def fetch_workflow_history_events(input)
  next_interceptor.fetch_workflow_history_events(input)
end

#heartbeat_async_activity(input) ⇒ `Object`

Called for every AsyncActivityHandle#heartbeat call.

Parameters:

input (HeartbeatAsyncActivityInput) —

Input.



430
431
432

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

def heartbeat_async_activity(input)
  next_interceptor.heartbeat_async_activity(input)
end

#list_schedules(input) ⇒ `Enumerator<Schedule::List::Description>`

Called for every Temporalio::Client#list_schedules call.

Parameters:

input (ListSchedulesInput) —

Input.

Returns:

(Enumerator<Schedule::List::Description>) —

Enumerable schedules.



373
374
375

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

def list_schedules(input)
  next_interceptor.list_schedules(input)
end

#list_workflows(input) ⇒ `Enumerator<WorkflowExecution>`

Called for every Temporalio::Client#list_workflows call.

Parameters:

input (ListWorkflowsInput) —

Input.

Returns:

(Enumerator<WorkflowExecution>) —

Enumerable workflow executions.



288
289
290

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

def list_workflows(input)
  next_interceptor.list_workflows(input)
end

#pause_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#pause call.

Parameters:

input (PauseScheduleInput) —

Input.



402
403
404

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

def pause_schedule(input)
  next_interceptor.pause_schedule(input)
end

#poll_workflow_update(input) ⇒ `Api::Update::V1::Outcome`

Called when polling for update result.

Parameters:

input (PollWorkflowUpdateInput) —

Input.

Returns:

(Api::Update::V1::Outcome) —

Update outcome.



343
344
345

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

def poll_workflow_update(input)
  next_interceptor.poll_workflow_update(input)
end

#query_workflow(input) ⇒ `Object`^?

Called for every WorkflowHandle#query call.

Parameters:

input (QueryWorkflowInput) —

Input.

Returns:

(Object, nil) —

Query result.



327
328
329

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

def query_workflow(input)
  next_interceptor.query_workflow(input)
end

#report_cancellation_async_activity(input) ⇒ `Object`

Called for every AsyncActivityHandle#report_cancellation call.

Parameters:

input (ReportCancellationAsyncActivityInput) —

Input.



451
452
453

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

def report_cancellation_async_activity(input)
  next_interceptor.report_cancellation_async_activity(input)
end

#signal_with_start_workflow(input) ⇒ `WorkflowHandle`

Called for every Temporalio::Client#signal_with_start_workflow.

Parameters:

input (SignalWithStartWorkflowInput) —

Input.

Returns:

(WorkflowHandle) —

Workflow handle.



280
281
282

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

def signal_with_start_workflow(input)
  next_interceptor.signal_with_start_workflow(input)
end

#signal_workflow(input) ⇒ `Object`

Called for every WorkflowHandle#signal call.

Parameters:

input (SignalWorkflowInput) —

Input.



319
320
321

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

def signal_workflow(input)
  next_interceptor.signal_workflow(input)
end

#start_update_with_start_workflow(input) ⇒ `WorkflowUpdateHandle`

Called for every Temporalio::Client#start_update_with_start_workflow and Temporalio::Client#execute_update_with_start_workflow call.

Parameters:

input (StartUpdateWithStartWorkflowInput) —

Input.

Returns:

(WorkflowUpdateHandle) —

Workflow update handle.



272
273
274

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

def start_update_with_start_workflow(input)
  next_interceptor.start_update_with_start_workflow(input)
end

#start_workflow(input) ⇒ `WorkflowHandle`

Called for every Temporalio::Client#start_workflow and Temporalio::Client#execute_workflow call.

Parameters:

input (StartWorkflowInput) —

Input.

Returns:

(WorkflowHandle) —

Workflow handle.



263
264
265

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

def start_workflow(input)
  next_interceptor.start_workflow(input)
end

#start_workflow_update(input) ⇒ `WorkflowUpdateHandle`

Called for every WorkflowHandle#start_update call.

Parameters:

input (StartWorkflowUpdateInput) —

Input.

Returns:

(WorkflowUpdateHandle) —

Update handle.



335
336
337

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

def start_workflow_update(input)
  next_interceptor.start_workflow_update(input)
end

#terminate_workflow(input) ⇒ `Object`

Called for every WorkflowHandle#terminate call.

Parameters:

input (TerminateWorkflowInput) —

Input.



357
358
359

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

def terminate_workflow(input)
  next_interceptor.terminate_workflow(input)
end

#trigger_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#trigger call.

Parameters:

input (TriggerScheduleInput) —

Input.



409
410
411

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

def trigger_schedule(input)
  next_interceptor.trigger_schedule(input)
end

#unpause_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#unpause call.

Parameters:

input (UnpauseScheduleInput) —

Input.



416
417
418

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

def unpause_schedule(input)
  next_interceptor.unpause_schedule(input)
end

#update_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#update call.

Parameters:

input (UpdateScheduleInput) —

Input.



423
424
425

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

def update_schedule(input)
  next_interceptor.update_schedule(input)
end

Class: Temporalio::Client::Interceptor::Outbound

Overview

Direct Known Subclasses

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(next_interceptor) ⇒ Outbound

Instance Attribute Details

#next_interceptor ⇒ Outbound (readonly)

Instance Method Details

#backfill_schedule(input) ⇒ Object

#cancel_workflow(input) ⇒ Object

#complete_async_activity(input) ⇒ Object

#count_workflows(input) ⇒ WorkflowExecutionCount

#create_schedule(input) ⇒ ScheduleHandle

#delete_schedule(input) ⇒ Object

#describe_schedule(input) ⇒ Schedule::Description

#describe_workflow(input) ⇒ WorkflowExecution::Description

#fail_async_activity(input) ⇒ Object

#fetch_workflow_history_events(input) ⇒ Enumerator<Api::History::V1::HistoryEvent>

#heartbeat_async_activity(input) ⇒ Object

#list_schedules(input) ⇒ Enumerator<Schedule::List::Description>

#list_workflows(input) ⇒ Enumerator<WorkflowExecution>

#pause_schedule(input) ⇒ Object

#poll_workflow_update(input) ⇒ Api::Update::V1::Outcome

#query_workflow(input) ⇒ Object?

#report_cancellation_async_activity(input) ⇒ Object

#signal_with_start_workflow(input) ⇒ WorkflowHandle

#signal_workflow(input) ⇒ Object

#start_update_with_start_workflow(input) ⇒ WorkflowUpdateHandle

#start_workflow(input) ⇒ WorkflowHandle

#start_workflow_update(input) ⇒ WorkflowUpdateHandle

#terminate_workflow(input) ⇒ Object

#trigger_schedule(input) ⇒ Object

#unpause_schedule(input) ⇒ Object

#update_schedule(input) ⇒ Object

#initialize(next_interceptor) ⇒ `Outbound`

#next_interceptor ⇒ `Outbound` (readonly)

#backfill_schedule(input) ⇒ `Object`

#cancel_workflow(input) ⇒ `Object`

#complete_async_activity(input) ⇒ `Object`

#count_workflows(input) ⇒ `WorkflowExecutionCount`

#create_schedule(input) ⇒ `ScheduleHandle`

#delete_schedule(input) ⇒ `Object`

#describe_schedule(input) ⇒ `Schedule::Description`

#describe_workflow(input) ⇒ `WorkflowExecution::Description`

#fail_async_activity(input) ⇒ `Object`

#fetch_workflow_history_events(input) ⇒ `Enumerator<Api::History::V1::HistoryEvent>`

#heartbeat_async_activity(input) ⇒ `Object`

#list_schedules(input) ⇒ `Enumerator<Schedule::List::Description>`

#list_workflows(input) ⇒ `Enumerator<WorkflowExecution>`

#pause_schedule(input) ⇒ `Object`

#poll_workflow_update(input) ⇒ `Api::Update::V1::Outcome`

#query_workflow(input) ⇒ `Object`^?

#report_cancellation_async_activity(input) ⇒ `Object`

#signal_with_start_workflow(input) ⇒ `WorkflowHandle`

#signal_workflow(input) ⇒ `Object`

#start_update_with_start_workflow(input) ⇒ `WorkflowUpdateHandle`

#start_workflow(input) ⇒ `WorkflowHandle`

#start_workflow_update(input) ⇒ `WorkflowUpdateHandle`

#terminate_workflow(input) ⇒ `Object`

#trigger_schedule(input) ⇒ `Object`

#unpause_schedule(input) ⇒ `Object`

#update_schedule(input) ⇒ `Object`