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.



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

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.



266
267
268
 
# File 'lib/temporalio/client/interceptor.rb', line 266

def next_interceptor
  @next_interceptor
end

Instance Method Details

#backfill_schedule(input) ⇒ Object

Called for every ScheduleHandle#backfill call.

Parameters:



396
397
398
 
# File 'lib/temporalio/client/interceptor.rb', line 396

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

#cancel_workflow(input) ⇒ Object

Called for every WorkflowHandle#cancel call.

Parameters:



366
367
368
 
# File 'lib/temporalio/client/interceptor.rb', line 366

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

#complete_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#complete call.

Parameters:



453
454
455
 
# File 'lib/temporalio/client/interceptor.rb', line 453

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:



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

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

#create_schedule(input) ⇒ ScheduleHandle

Called for every Temporalio::Client#create_schedule call.

Parameters:

Returns:



381
382
383
 
# File 'lib/temporalio/client/interceptor.rb', line 381

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

#delete_schedule(input) ⇒ Object

Called for every ScheduleHandle#delete call.

Parameters:



403
404
405
 
# File 'lib/temporalio/client/interceptor.rb', line 403

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

#describe_schedule(input) ⇒ Schedule::Description

Called for every ScheduleHandle#describe call.

Parameters:

Returns:



411
412
413
 
# File 'lib/temporalio/client/interceptor.rb', line 411

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

#describe_workflow(input) ⇒ WorkflowExecution::Description

Called for every WorkflowHandle#describe call.

Parameters:

Returns:



320
321
322
 
# File 'lib/temporalio/client/interceptor.rb', line 320

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

#fail_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#fail call.

Parameters:



460
461
462
 
# File 'lib/temporalio/client/interceptor.rb', line 460

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:



328
329
330
 
# File 'lib/temporalio/client/interceptor.rb', line 328

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:



446
447
448
 
# File 'lib/temporalio/client/interceptor.rb', line 446

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:



389
390
391
 
# File 'lib/temporalio/client/interceptor.rb', line 389

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

#list_workflow_page(input) ⇒ Client::ListWorkflowPage

Called for every Temporalio::Client#list_workflow_page call.

Parameters:

Returns:



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

def list_workflow_page(input)
  next_interceptor.list_workflow_page(input)
end

#pause_schedule(input) ⇒ Object

Called for every ScheduleHandle#pause call.

Parameters:



418
419
420
 
# File 'lib/temporalio/client/interceptor.rb', line 418

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:



359
360
361
 
# File 'lib/temporalio/client/interceptor.rb', line 359

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.



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

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

#report_cancellation_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#report_cancellation call.

Parameters:



467
468
469
 
# File 'lib/temporalio/client/interceptor.rb', line 467

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:



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

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:



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

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:



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

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:



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

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

#start_workflow_update(input) ⇒ WorkflowUpdateHandle

Called for every WorkflowHandle#start_update call.

Parameters:

Returns:



351
352
353
 
# File 'lib/temporalio/client/interceptor.rb', line 351

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

#terminate_workflow(input) ⇒ Object

Called for every WorkflowHandle#terminate call.

Parameters:



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

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

#trigger_schedule(input) ⇒ Object

Called for every ScheduleHandle#trigger call.

Parameters:



425
426
427
 
# File 'lib/temporalio/client/interceptor.rb', line 425

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

#unpause_schedule(input) ⇒ Object

Called for every ScheduleHandle#unpause call.

Parameters:



432
433
434
 
# File 'lib/temporalio/client/interceptor.rb', line 432

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

#update_schedule(input) ⇒ Object

Called for every ScheduleHandle#update call.

Parameters:



439
440
441
 
# File 'lib/temporalio/client/interceptor.rb', line 439

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