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_activity(input) ⇒ Object
Called for every ActivityHandle#cancel call.
#cancel_workflow(input) ⇒ Object
Called for every WorkflowHandle#cancel call.
#complete_async_activity(input) ⇒ Object
Called for every AsyncActivityHandle#complete call.
#count_activities(input) ⇒ ActivityExecutionCount
Called for every Temporalio::Client#count_activities 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_activity(input) ⇒ ActivityExecution::Description
Called for every ActivityHandle#describe 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_activity_outcome(input) ⇒ Api::Activity::V1::ActivityExecutionOutcome
Called by ActivityHandle#result to long-poll the activity outcome.
#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_activities(input) ⇒ Enumerator<ActivityExecution>
Called for every Temporalio::Client#list_activities call.
#list_schedules(input) ⇒ Enumerator<Schedule::List::Description>
Called for every Temporalio::Client#list_schedules call.
#list_workflow_page(input) ⇒ Client::ListWorkflowPage
Called for every Temporalio::Client#list_workflow_page call.
#pause_activity(input) ⇒ Object
Called for every ActivityHandle#pause 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_activity(input) ⇒ ActivityHandle
Called for every Temporalio::Client#start_activity and Temporalio::Client#execute_activity 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_activity(input) ⇒ Object
Called for every ActivityHandle#terminate call.
#terminate_workflow(input) ⇒ Object
Called for every WorkflowHandle#terminate call.
#trigger_schedule(input) ⇒ Object
Called for every ScheduleHandle#trigger call.
#unpause_activity(input) ⇒ Object
Called for every ActivityHandle#unpause call.
#unpause_schedule(input) ⇒ Object
Called for every ScheduleHandle#unpause call.
#update_activity_options(input) ⇒ Api::Activity::V1::ActivityOptions
Called for every ActivityHandle#update_options 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.



389
390
391

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

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.



384
385
386

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

def next_interceptor
  @next_interceptor
end

Instance Method Details

#backfill_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#backfill call.

Parameters:

input (BackfillScheduleInput) —
Input.



514
515
516

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

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

#cancel_activity(input) ⇒ `Object`

Called for every ActivityHandle#cancel call.

WARNING: Standalone Activities are experimental.

Parameters:

input (CancelActivityInput) —
Input.



614
615
616

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

def cancel_activity(input)
  next_interceptor.cancel_activity(input)
end

#cancel_workflow(input) ⇒ `Object`

Called for every WorkflowHandle#cancel call.

Parameters:

input (CancelWorkflowInput) —
Input.



484
485
486

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

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.



571
572
573

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

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

#count_activities(input) ⇒ `ActivityExecutionCount`

Called for every Temporalio::Client#count_activities call.

WARNING: Standalone Activities are experimental.

Parameters:

input (CountActivitiesInput) —
Input.

Returns:

(ActivityExecutionCount) —
Activity count.



671
672
673

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

def count_activities(input)
  next_interceptor.count_activities(input)
end

#count_workflows(input) ⇒ `WorkflowExecutionCount`

Called for every Temporalio::Client#count_workflows call.

Parameters:

input (CountWorkflowsInput) —
Input.

Returns:

(WorkflowExecutionCount) —
Workflow count.



430
431
432

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

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.



499
500
501

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

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

#delete_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#delete call.

Parameters:

input (DeleteScheduleInput) —
Input.



521
522
523

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

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

#describe_activity(input) ⇒ `ActivityExecution::Description`

Called for every ActivityHandle#describe call.

WARNING: Standalone Activities are experimental.

Parameters:

input (DescribeActivityInput) —
Input.

Returns:

(ActivityExecution::Description) —
Activity description.



605
606
607

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

def describe_activity(input)
  next_interceptor.describe_activity(input)
end

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

Called for every ScheduleHandle#describe call.

Parameters:

input (DescribeScheduleInput) —
Input.

Returns:

(Schedule::Description) —
Schedule description.



529
530
531

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

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.



438
439
440

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

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.



578
579
580

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

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

#fetch_activity_outcome(input) ⇒ `Api::Activity::V1::ActivityExecutionOutcome`

Called by ActivityHandle#result to long-poll the activity outcome.

WARNING: Standalone Activities are experimental.

Parameters:

input (FetchActivityOutcomeInput) —
Input.

Returns:

(Api::Activity::V1::ActivityExecutionOutcome) —
Activity outcome.



681
682
683

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

def fetch_activity_outcome(input)
  next_interceptor.fetch_activity_outcome(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.



446
447
448

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

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.



564
565
566

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

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

#list_activities(input) ⇒ `Enumerator<ActivityExecution>`

Called for every Temporalio::Client#list_activities call.

WARNING: Standalone Activities are experimental.

Parameters:

input (ListActivitiesInput) —
Input.

Returns:

(Enumerator<ActivityExecution>) —
Activity executions.



661
662
663

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

def list_activities(input)
  next_interceptor.list_activities(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.



507
508
509

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

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:

input (ListWorkflowPageInput) —
Input.

Returns:

(Client::ListWorkflowPage) —
Enumerable workflow executions, with a #next_page_token method.



422
423
424

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

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

#pause_activity(input) ⇒ `Object`

Called for every ActivityHandle#pause call.

WARNING: Standalone Activities are experimental.

Parameters:

input (PauseActivityInput) —
Input.



632
633
634

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

def pause_activity(input)
  next_interceptor.pause_activity(input)
end

#pause_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#pause call.

Parameters:

input (PauseScheduleInput) —
Input.



536
537
538

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

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.



477
478
479

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

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.



461
462
463

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

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.



585
586
587

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

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.



414
415
416

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

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.



453
454
455

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

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

#start_activity(input) ⇒ `ActivityHandle`

Called for every Temporalio::Client#start_activity and Temporalio::Client#execute_activity call.

WARNING: Standalone Activities are experimental.

Parameters:

input (StartActivityInput) —
Input.

Returns:

(ActivityHandle) —
Activity handle.



595
596
597

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

def start_activity(input)
  next_interceptor.start_activity(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.



406
407
408

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

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.



397
398
399

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

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.



469
470
471

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

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

#terminate_activity(input) ⇒ `Object`

Called for every ActivityHandle#terminate call.

WARNING: Standalone Activities are experimental.

Parameters:

input (TerminateActivityInput) —
Input.



623
624
625

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

def terminate_activity(input)
  next_interceptor.terminate_activity(input)
end

#terminate_workflow(input) ⇒ `Object`

Called for every WorkflowHandle#terminate call.

Parameters:

input (TerminateWorkflowInput) —
Input.



491
492
493

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

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

#trigger_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#trigger call.

Parameters:

input (TriggerScheduleInput) —
Input.



543
544
545

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

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

#unpause_activity(input) ⇒ `Object`

Called for every ActivityHandle#unpause call.

WARNING: Standalone Activities are experimental.

Parameters:

input (UnpauseActivityInput) —
Input.



641
642
643

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

def unpause_activity(input)
  next_interceptor.unpause_activity(input)
end

#unpause_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#unpause call.

Parameters:

input (UnpauseScheduleInput) —
Input.



550
551
552

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

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

#update_activity_options(input) ⇒ `Api::Activity::V1::ActivityOptions`

Called for every ActivityHandle#update_options call.

WARNING: Standalone Activities are experimental.

Parameters:

input (UpdateActivityOptionsInput) —
Input.

Returns:

(Api::Activity::V1::ActivityOptions) —
Activity options after the update.



651
652
653

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

def update_activity_options(input)
  next_interceptor.update_activity_options(input)
end

#update_schedule(input) ⇒ `Object`

Called for every ScheduleHandle#update call.

Parameters:

input (UpdateScheduleInput) —
Input.



557
558
559

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

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_activity(input) ⇒ Object

#cancel_workflow(input) ⇒ Object

#complete_async_activity(input) ⇒ Object

#count_activities(input) ⇒ ActivityExecutionCount

#count_workflows(input) ⇒ WorkflowExecutionCount

#create_schedule(input) ⇒ ScheduleHandle

#delete_schedule(input) ⇒ Object

#describe_activity(input) ⇒ ActivityExecution::Description

#describe_schedule(input) ⇒ Schedule::Description

#describe_workflow(input) ⇒ WorkflowExecution::Description

#fail_async_activity(input) ⇒ Object

#fetch_activity_outcome(input) ⇒ Api::Activity::V1::ActivityExecutionOutcome

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

#heartbeat_async_activity(input) ⇒ Object

#list_activities(input) ⇒ Enumerator<ActivityExecution>

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

#list_workflow_page(input) ⇒ Client::ListWorkflowPage

#pause_activity(input) ⇒ Object

#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_activity(input) ⇒ ActivityHandle

#start_update_with_start_workflow(input) ⇒ WorkflowUpdateHandle

#start_workflow(input) ⇒ WorkflowHandle

#start_workflow_update(input) ⇒ WorkflowUpdateHandle

#terminate_activity(input) ⇒ Object

#terminate_workflow(input) ⇒ Object

#trigger_schedule(input) ⇒ Object

#unpause_activity(input) ⇒ Object

#unpause_schedule(input) ⇒ Object

#update_activity_options(input) ⇒ Api::Activity::V1::ActivityOptions

#update_schedule(input) ⇒ Object

#initialize(next_interceptor) ⇒ `Outbound`

#next_interceptor ⇒ `Outbound` (readonly)

#backfill_schedule(input) ⇒ `Object`

#cancel_activity(input) ⇒ `Object`

#cancel_workflow(input) ⇒ `Object`

#complete_async_activity(input) ⇒ `Object`

#count_activities(input) ⇒ `ActivityExecutionCount`

#count_workflows(input) ⇒ `WorkflowExecutionCount`

#create_schedule(input) ⇒ `ScheduleHandle`

#delete_schedule(input) ⇒ `Object`

#describe_activity(input) ⇒ `ActivityExecution::Description`

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

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

#fail_async_activity(input) ⇒ `Object`

#fetch_activity_outcome(input) ⇒ `Api::Activity::V1::ActivityExecutionOutcome`

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

#heartbeat_async_activity(input) ⇒ `Object`

#list_activities(input) ⇒ `Enumerator<ActivityExecution>`

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

#list_workflow_page(input) ⇒ `Client::ListWorkflowPage`

#pause_activity(input) ⇒ `Object`

#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_activity(input) ⇒ `ActivityHandle`

#start_update_with_start_workflow(input) ⇒ `WorkflowUpdateHandle`

#start_workflow(input) ⇒ `WorkflowHandle`

#start_workflow_update(input) ⇒ `WorkflowUpdateHandle`

#terminate_activity(input) ⇒ `Object`

#terminate_workflow(input) ⇒ `Object`

#trigger_schedule(input) ⇒ `Object`

#unpause_activity(input) ⇒ `Object`

#unpause_schedule(input) ⇒ `Object`

#update_activity_options(input) ⇒ `Api::Activity::V1::ActivityOptions`

#update_schedule(input) ⇒ `Object`