Class: OpenTelemetryWorkflowClientInterceptor
Intercepts calls to start a Workflow.
Wraps the operation in an opentelemetry Span and passes it to the Workflow via headers.
Implements
Constructors
Constructor
new OpenTelemetryWorkflowClientInterceptor(
options?):OpenTelemetryWorkflowClientInterceptor
Parameters
options?
InterceptorOptions
Returns
OpenTelemetryWorkflowClientInterceptor
Methods
cancel()
cancel(
input,next):Promise<IRequestCancelWorkflowExecutionResponse>
Intercept a service call to requestCancelWorkflowExecution
Parameters
input
next
OmitLastParam<(input, next) => Promise<IRequestCancelWorkflowExecutionResponse>>
Returns
Promise<IRequestCancelWorkflowExecutionResponse>
Implementation of
WorkflowClientInterceptor.cancel
describe()
describe(
input,next):Promise<IDescribeWorkflowExecutionResponse>
Intercept a service call to describeWorkflowExecution
Parameters
input
next
OmitLastParam<(input, next) => Promise<IDescribeWorkflowExecutionResponse>>
Returns
Promise<IDescribeWorkflowExecutionResponse>
Implementation of
WorkflowClientInterceptor.describe
fetchHistory()
fetchHistory(
input,next):Promise<IHistory>
Experimental
Intercept a service call to getWorkflowExecutionHistory
This interceptor method is experimental - API changes are still possible.
Parameters
input
next
OmitLastParam<(input, next) => Promise<IHistory>>
Returns
Promise<IHistory>
Implementation of
WorkflowClientInterceptor.fetchHistory
list()
list(
input,next):AsyncIterable<WorkflowExecutionInfo>
Experimental
Intercept a service call to listWorkflowExecutions
One interception spans a single consumption of the returned async iterable, including pagination across multiple RPCs and early consumer termination.
This interceptor method is experimental - API changes are still possible.
Parameters
input
next
OmitLastParam<(input, next) => AsyncIterable<WorkflowExecutionInfo>>
Returns
AsyncIterable<WorkflowExecutionInfo>
Implementation of
WorkflowClientInterceptor.list
query()
query(
input,next):Promise<unknown>
Intercept a service call to queryWorkflow
Parameters
input
next
OmitLastParam<(input, next) => Promise<unknown>>
Returns
Promise<unknown>
Implementation of
WorkflowClientInterceptor.query
signal()
signal(
input,next):Promise<void>
Intercept a service call to signalWorkflowExecution
If you implement this method, signalWithStart most likely needs to be implemented too
Parameters
input
next
OmitLastParam<(input, next) => Promise<void>>
Returns
Promise<void>
Implementation of
WorkflowClientInterceptor.signal
signalWithStart()
signalWithStart(
input,next):Promise<string>
Intercept a service call to signalWithStartWorkflowExecution
Parameters
input
next
OmitLastParam<(input, next) => Promise<string>>
Returns
Promise<string>
Implementation of
WorkflowClientInterceptor.signalWithStart
start()
start(
input,next):Promise<string>
Intercept a service call to startWorkflowExecution
If you implement this method, signalWithStart most likely needs to be implemented too
Parameters
input
next
OmitLastParam<(input, next) => Promise<string>>
Returns
Promise<string>
Deprecated
in favour of startWithDetails
Implementation of
WorkflowClientInterceptor.start
startUpdate()
startUpdate(
input,next):Promise<WorkflowStartUpdateOutput>
Intercept a service call to updateWorkflowExecution
Parameters
input
next
OmitLastParam<(input, next) => Promise<WorkflowStartUpdateOutput>>
Returns
Promise<WorkflowStartUpdateOutput>
Implementation of
WorkflowClientInterceptor.startUpdate
startUpdateWithStart()
startUpdateWithStart(
input,next):Promise<WorkflowStartUpdateWithStartOutput>
Intercept a service call to startUpdateWithStart
Parameters
input
WorkflowStartUpdateWithStartInput
next
OmitLastParam<(input, next) => Promise<WorkflowStartUpdateWithStartOutput>>
Returns
Promise<WorkflowStartUpdateWithStartOutput>
Implementation of
WorkflowClientInterceptor.startUpdateWithStart
startWithDetails()
startWithDetails(
input,next):Promise<WorkflowStartOutput>
Intercept a service call to startWorkflowExecution
This method returns start details via WorkflowStartOutput.
If you implement this method, signalWithStart most likely needs to be implemented too
Parameters
input
next
OmitLastParam<(input, next) => Promise<WorkflowStartOutput>>
Returns
Promise<WorkflowStartOutput>
Implementation of
WorkflowClientInterceptor.startWithDetails
terminate()
terminate(
input,next):Promise<ITerminateWorkflowExecutionResponse>
Intercept a service call to terminateWorkflowExecution
Parameters
input
next
OmitLastParam<(input, next) => Promise<ITerminateWorkflowExecutionResponse>>
Returns
Promise<ITerminateWorkflowExecutionResponse>