Class ClientOutboundInterceptor

Namespace

Temporalio.Client.Interceptors

Assembly

Temporalio.dll

Base class for all outbound interceptors.

public abstract class ClientOutboundInterceptor

Inheritance

object

ClientOutboundInterceptor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ClientOutboundInterceptor(ClientOutboundInterceptor)

Initializes a new instance of the ClientOutboundInterceptor class.

protected ClientOutboundInterceptor(ClientOutboundInterceptor next)

Parameters

next ClientOutboundInterceptor

Next outbound interceptor in the chain.

Properties

Next

Gets the next interceptor in the chain.

protected ClientOutboundInterceptor Next { get; }

Property Value

ClientOutboundInterceptor

Methods

BackfillScheduleAsync(BackfillScheduleInput)

Intercept backfill schedule calls.

public virtual Task BackfillScheduleAsync(BackfillScheduleInput input)

Parameters

input BackfillScheduleInput

Input details of the call.

Returns

Task

Task for completion.

CancelWorkflowAsync(CancelWorkflowInput)

Intercept cancel workflow calls.

public virtual Task CancelWorkflowAsync(CancelWorkflowInput input)

Parameters

input CancelWorkflowInput

Input details of the call.

Returns

Task

Task for acceptance of the cancel.

CompleteAsyncActivityAsync(CompleteAsyncActivityInput)

Intercept async activity complete calls.

public virtual Task CompleteAsyncActivityAsync(CompleteAsyncActivityInput input)

Parameters

input CompleteAsyncActivityInput

Input details of the call.

Returns

Task

Task completion.

CountWorkflowsAsync(CountWorkflowsInput)

Intercept counting workflows.

public virtual Task<WorkflowExecutionCount> CountWorkflowsAsync(CountWorkflowsInput input)

Parameters

input CountWorkflowsInput

Input details of the call.

Returns

Task<WorkflowExecutionCount>

Count information for the workflows.

CreateScheduleAsync(CreateScheduleInput)

Intercept create schedule calls.

public virtual Task<ScheduleHandle> CreateScheduleAsync(CreateScheduleInput input)

Parameters

input CreateScheduleInput

Input details of the call.

Returns

Task<ScheduleHandle>

Schedule handle.

DeleteScheduleAsync(DeleteScheduleInput)

Intercept delete schedule calls.

public virtual Task DeleteScheduleAsync(DeleteScheduleInput input)

Parameters

input DeleteScheduleInput

Input details of the call.

Returns

Task

Task for completion.

DescribeScheduleAsync(DescribeScheduleInput)

Intercept describe schedule calls.

public virtual Task<ScheduleDescription> DescribeScheduleAsync(DescribeScheduleInput input)

Parameters

input DescribeScheduleInput

Input details of the call.

Returns

Task<ScheduleDescription>

Schedule description.

DescribeWorkflowAsync(DescribeWorkflowInput)

Intercept describe workflow calls.

public virtual Task<WorkflowExecutionDescription> DescribeWorkflowAsync(DescribeWorkflowInput input)

Parameters

input DescribeWorkflowInput

Input details of the call.

Returns

Task<WorkflowExecutionDescription>

Workflow execution description.

FailAsyncActivityAsync(FailAsyncActivityInput)

Intercept async activity fail calls.

public virtual Task FailAsyncActivityAsync(FailAsyncActivityInput input)

Parameters

input FailAsyncActivityInput

Input details of the call.

Returns

Task

Task completion.

FetchWorkflowHistoryEventPageAsync(FetchWorkflowHistoryEventPageInput)

Intercept a history event page fetch.

public virtual Task<WorkflowHistoryEventPage> FetchWorkflowHistoryEventPageAsync(FetchWorkflowHistoryEventPageInput input)

Parameters

input FetchWorkflowHistoryEventPageInput

Input details of the call.

Returns

Task<WorkflowHistoryEventPage>

Event page. This will not return an empty event set and a next page token.

GetWorkerBuildIdCompatibilityAsync(GetWorkerBuildIdCompatibilityInput)

Intercept get worker build id compatability calls.

public virtual Task<WorkerBuildIdVersionSets?> GetWorkerBuildIdCompatibilityAsync(GetWorkerBuildIdCompatibilityInput input)

Parameters

input GetWorkerBuildIdCompatibilityInput

Input details of the call.

Returns

Task<WorkerBuildIdVersionSets>

The sets, if the Task Queue is versioned, otherwise null.

GetWorkerTaskReachabilityAsync(GetWorkerTaskReachabilityInput)

Intercept get worker build id compatability calls.

public virtual Task<WorkerTaskReachability> GetWorkerTaskReachabilityAsync(GetWorkerTaskReachabilityInput input)

Parameters

input GetWorkerTaskReachabilityInput

Input details of the call.

Returns

Task<WorkerTaskReachability>

The reachability information.

HeartbeatAsyncActivityAsync(HeartbeatAsyncActivityInput)

Intercept async activity heartbeat calls.

public virtual Task HeartbeatAsyncActivityAsync(HeartbeatAsyncActivityInput input)

Parameters

input HeartbeatAsyncActivityInput

Input details of the call.

Returns

Task

Task completion.

ListSchedulesAsync(ListSchedulesInput)

Intercept list schedules calls.

public virtual IAsyncEnumerable<ScheduleListDescription> ListSchedulesAsync(ListSchedulesInput input)

Parameters

input ListSchedulesInput

Input details of the call.

Returns

IAsyncEnumerable<ScheduleListDescription>

Schedule enumerable.

ListWorkflowsAsync(ListWorkflowsInput)

Intercept listing workflows.

public virtual IAsyncEnumerable<WorkflowExecution> ListWorkflowsAsync(ListWorkflowsInput input)

Parameters

input ListWorkflowsInput

Input details of the call.

Returns

IAsyncEnumerable<WorkflowExecution>

Async enumerator for the workflows.

Remarks

This method only gets called by ListWorkflowsAsync(string, WorkflowListOptions?). It does not get called by ListWorkflowsPaginatedAsync(string, byte[]?, WorkflowListPaginatedOptions?). This method is called before the first page is fetched. Afterwards, before each page fetched (including before the first page), ListWorkflowsPaginatedAsync(ListWorkflowsPaginatedInput) is called.

ListWorkflowsPaginatedAsync(ListWorkflowsPaginatedInput)

Intercept page fetch for list workflows calls.

public virtual Task<WorkflowListPage> ListWorkflowsPaginatedAsync(ListWorkflowsPaginatedInput input)

Parameters

input ListWorkflowsPaginatedInput

Input details of the call.

Returns

Task<WorkflowListPage>

A single page of query results.

Remarks

This method is called each time ListWorkflowsPaginatedAsync(string, byte[]?, WorkflowListPaginatedOptions?) is called. It also gets called for each page fetched when iterating the enumerable returned by ListWorkflowsAsync(string, WorkflowListOptions?).

PauseScheduleAsync(PauseScheduleInput)

Intercept pause schedule calls.

public virtual Task PauseScheduleAsync(PauseScheduleInput input)

Parameters

input PauseScheduleInput

Input details of the call.

Returns

Task

Task for completion.

QueryWorkflowAsync<TResult>(QueryWorkflowInput)

Intercept query workflow calls.

public virtual Task<TResult> QueryWorkflowAsync<TResult>(QueryWorkflowInput input)

Parameters

input QueryWorkflowInput

Input details of the call.

Returns

Task<TResult>

Result of the query.

Type Parameters

TResult

Return type of the query.

ReportCancellationAsyncActivityAsync(ReportCancellationAsyncActivityInput)

Intercept async activity report cancellation calls.

public virtual Task ReportCancellationAsyncActivityAsync(ReportCancellationAsyncActivityInput input)

Parameters

input ReportCancellationAsyncActivityInput

Input details of the call.

Returns

Task

Task completion.

SignalWorkflowAsync(SignalWorkflowInput)

Intercept signal workflow calls.

public virtual Task SignalWorkflowAsync(SignalWorkflowInput input)

Parameters

input SignalWorkflowInput

Input details of the call.

Returns

Task

Task for acceptance of the signal.

StartUpdateWithStartWorkflowAsync<TUpdateResult>(StartUpdateWithStartWorkflowInput)

Intercept start update with start workflow calls.

public virtual Task<WorkflowUpdateHandle<TUpdateResult>> StartUpdateWithStartWorkflowAsync<TUpdateResult>(StartUpdateWithStartWorkflowInput input)

Parameters

input StartUpdateWithStartWorkflowInput

Input details of the call.

Returns

Task<WorkflowUpdateHandle<TUpdateResult>>

Handle for the update.

Type Parameters

TUpdateResult

Update result type.

StartWorkflowAsync<TWorkflow, TResult>(StartWorkflowInput)

Intercept start workflow calls.

public virtual Task<WorkflowHandle<TWorkflow, TResult>> StartWorkflowAsync<TWorkflow, TResult>(StartWorkflowInput input)

Parameters

input StartWorkflowInput

Input details of the call.

Returns

Task<WorkflowHandle<TWorkflow, TResult>>

Handle for the workflow.

Type Parameters

TWorkflow

Workflow class type. May be ValueTuple if unknown.

TResult

Result type of the workflow. May be ValueTuple if unknown.

StartWorkflowUpdateAsync<TResult>(StartWorkflowUpdateInput)

Intercept start workflow update calls.

public virtual Task<WorkflowUpdateHandle<TResult>> StartWorkflowUpdateAsync<TResult>(StartWorkflowUpdateInput input)

Parameters

input StartWorkflowUpdateInput

Input details of the call.

Returns

Task<WorkflowUpdateHandle<TResult>>

Handle for the update.

Type Parameters

TResult

Return type of the update. This may be ValueTuple if user is discarding result.

TerminateWorkflowAsync(TerminateWorkflowInput)

Intercept terminate workflow calls.

public virtual Task TerminateWorkflowAsync(TerminateWorkflowInput input)

Parameters

input TerminateWorkflowInput

Input details of the call.

Returns

Task

Task for termination completion.

TriggerScheduleAsync(TriggerScheduleInput)

Intercept trigger schedule calls.

public virtual Task TriggerScheduleAsync(TriggerScheduleInput input)

Parameters

input TriggerScheduleInput

Input details of the call.

Returns

Task

Task for completion.

UnpauseScheduleAsync(UnpauseScheduleInput)

Intercept unpause schedule calls.

public virtual Task UnpauseScheduleAsync(UnpauseScheduleInput input)

Parameters

input UnpauseScheduleInput

Input details of the call.

Returns

Task

Task for completion.

UpdateScheduleAsync(UpdateScheduleInput)

Intercept update schedule calls.

public virtual Task UpdateScheduleAsync(UpdateScheduleInput input)

Parameters

input UpdateScheduleInput

Input details of the call.

Returns

Task

Task for completion.

UpdateWorkerBuildIdCompatibilityAsync(UpdateWorkerBuildIdCompatibilityInput)

Intercept update worker build id compatability calls.

public virtual Task UpdateWorkerBuildIdCompatibilityAsync(UpdateWorkerBuildIdCompatibilityInput input)

Parameters

input UpdateWorkerBuildIdCompatibilityInput

Input details of the call.

Returns

Task

Completion task.