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

Inherits:
Object
  • Object
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

Instance Method Summary collapse

Constructor Details

#initialize(next_interceptor) ⇒ Outbound

Initialize outbound with the next interceptor in the chain.

Parameters:

  • next_interceptor (Outbound) —

    Next interceptor in the chain.



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

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.



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

def next_interceptor
  @next_interceptor
end

Instance Method Details

#backfill_schedule(input) ⇒ Object

Called for every ScheduleHandle#backfill call.

Parameters:



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

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

#cancel_workflow(input) ⇒ Object

Called for every WorkflowHandle#cancel call.

Parameters:



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

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

#complete_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#complete call.

Parameters:



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

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:

Returns:



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

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

#create_schedule(input) ⇒ ScheduleHandle

Called for every Temporalio::Client#create_schedule call.

Parameters:

Returns:



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

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

#delete_schedule(input) ⇒ Object

Called for every ScheduleHandle#delete call.

Parameters:



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

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

#describe_schedule(input) ⇒ Schedule::Description

Called for every ScheduleHandle#describe call.

Parameters:

Returns:



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

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

#describe_workflow(input) ⇒ WorkflowExecution::Description

Called for every WorkflowHandle#describe call.

Parameters:

Returns:



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

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

#fail_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#fail call.

Parameters:



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

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:

Returns:



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

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:



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

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:

Returns:



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

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

#list_workflows(input) ⇒ Enumerator<WorkflowExecution>

Called for every Temporalio::Client#list_workflows call.

Parameters:

Returns:



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

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

#pause_schedule(input) ⇒ Object

Called for every ScheduleHandle#pause call.

Parameters:



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

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:

Returns:



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

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

#query_workflow(input) ⇒ Object?

Called for every WorkflowHandle#query call.

Parameters:

Returns:

  • (Object, nil) —

    Query result.



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

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

#report_cancellation_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#report_cancellation call.

Parameters:



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

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:

Returns:



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

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:



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

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:

Returns:



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

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:

Returns:



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

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

#start_workflow_update(input) ⇒ WorkflowUpdateHandle

Called for every WorkflowHandle#start_update call.

Parameters:

Returns:



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

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

#terminate_workflow(input) ⇒ Object

Called for every WorkflowHandle#terminate call.

Parameters:



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

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

#trigger_schedule(input) ⇒ Object

Called for every ScheduleHandle#trigger call.

Parameters:



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

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

#unpause_schedule(input) ⇒ Object

Called for every ScheduleHandle#unpause call.

Parameters:



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

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

#update_schedule(input) ⇒ Object

Called for every ScheduleHandle#update call.

Parameters:



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

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