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.



257
258
259
 
# File 'lib/temporalio/client/interceptor.rb', line 257

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.



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

def next_interceptor
  @next_interceptor
end

Instance Method Details

#backfill_schedule(input) ⇒ Object

Called for every ScheduleHandle#backfill call.

Parameters:



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

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

#cancel_workflow(input) ⇒ Object

Called for every WorkflowHandle#cancel call.

Parameters:



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

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

#complete_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#complete call.

Parameters:



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

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:



298
299
300
 
# File 'lib/temporalio/client/interceptor.rb', line 298

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

#create_schedule(input) ⇒ ScheduleHandle

Called for every Temporalio::Client#create_schedule call.

Parameters:

Returns:



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

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

#delete_schedule(input) ⇒ Object

Called for every ScheduleHandle#delete call.

Parameters:



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

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

#describe_schedule(input) ⇒ Schedule::Description

Called for every ScheduleHandle#describe call.

Parameters:

Returns:



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

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

#describe_workflow(input) ⇒ WorkflowExecution::Description

Called for every WorkflowHandle#describe call.

Parameters:

Returns:



306
307
308
 
# File 'lib/temporalio/client/interceptor.rb', line 306

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

#fail_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#fail call.

Parameters:



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

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:



314
315
316
 
# File 'lib/temporalio/client/interceptor.rb', line 314

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:



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

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:



375
376
377
 
# File 'lib/temporalio/client/interceptor.rb', line 375

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:



290
291
292
 
# File 'lib/temporalio/client/interceptor.rb', line 290

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

#pause_schedule(input) ⇒ Object

Called for every ScheduleHandle#pause call.

Parameters:



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

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:



345
346
347
 
# File 'lib/temporalio/client/interceptor.rb', line 345

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.



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

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

#report_cancellation_async_activity(input) ⇒ Object

Called for every AsyncActivityHandle#report_cancellation call.

Parameters:



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

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:



282
283
284
 
# File 'lib/temporalio/client/interceptor.rb', line 282

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:



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

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:



274
275
276
 
# File 'lib/temporalio/client/interceptor.rb', line 274

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:



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

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

#start_workflow_update(input) ⇒ WorkflowUpdateHandle

Called for every WorkflowHandle#start_update call.

Parameters:

Returns:



337
338
339
 
# File 'lib/temporalio/client/interceptor.rb', line 337

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

#terminate_workflow(input) ⇒ Object

Called for every WorkflowHandle#terminate call.

Parameters:



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

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

#trigger_schedule(input) ⇒ Object

Called for every ScheduleHandle#trigger call.

Parameters:



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

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

#unpause_schedule(input) ⇒ Object

Called for every ScheduleHandle#unpause call.

Parameters:



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

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

#update_schedule(input) ⇒ Object

Called for every ScheduleHandle#update call.

Parameters:



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

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