Skip to main content

Class: OpenTelemetryWorkflowClientInterceptor

opentelemetry.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

NameType
options?InterceptorOptions

Returns

OpenTelemetryWorkflowClientInterceptor

Methods

cancel

cancel(input, next): Promise<IRequestCancelWorkflowExecutionResponse>

Parameters

NameType
inputWorkflowCancelInput
nextOmitLastParam<(input: WorkflowCancelInput, next: OmitLastParam<(input: WorkflowCancelInput, next: OmitLastParam<...>) => Promise<IRequestCancelWorkflowExecutionResponse>>) => Promise<IRequestCancelWorkflowExecutionResponse>>

Returns

Promise<IRequestCancelWorkflowExecutionResponse>

Implementation of

WorkflowClientInterceptor.cancel


describe

describe(input, next): Promise<IDescribeWorkflowExecutionResponse>

Parameters

NameType
inputWorkflowDescribeInput
nextOmitLastParam<(input: WorkflowDescribeInput, next: OmitLastParam<(input: WorkflowDescribeInput, next: OmitLastParam<...>) => Promise<IDescribeWorkflowExecutionResponse>>) => Promise<IDescribeWorkflowExecutionResponse>>

Returns

Promise<IDescribeWorkflowExecutionResponse>

Implementation of

WorkflowClientInterceptor.describe


query

query(input, next): Promise<unknown>

Parameters

NameType
inputWorkflowQueryInput
nextOmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<(input: WorkflowQueryInput, next: OmitLastParam<...>) => Promise<unknown>>) => Promise<unknown>>

Returns

Promise<unknown>

Implementation of

WorkflowClientInterceptor.query


signal

signal(input, next): Promise<void>

Parameters

NameType
inputWorkflowSignalInput
nextOmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<(input: WorkflowSignalInput, next: OmitLastParam<...>) => Promise<void>>) => Promise<void>>

Returns

Promise<void>

Implementation of

WorkflowClientInterceptor.signal


signalWithStart

signalWithStart(input, next): Promise<string>

Parameters

NameType
inputWorkflowSignalWithStartInput
nextOmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<(input: WorkflowSignalWithStartInput, next: OmitLastParam<...>) => Promise<string>>) => Promise<string>>

Returns

Promise<string>

Implementation of

WorkflowClientInterceptor.signalWithStart


start

start(input, next): Promise<string>

Parameters

NameType
inputWorkflowStartInput
nextOmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<string>>) => Promise<string>>

Returns

Promise<string>

Implementation of

WorkflowClientInterceptor.start


startUpdate

startUpdate(input, next): Promise<WorkflowStartUpdateOutput>

Parameters

NameType
inputWorkflowStartUpdateInput
nextOmitLastParam<(input: WorkflowStartUpdateInput, next: OmitLastParam<(input: WorkflowStartUpdateInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateOutput>>) => Promise<WorkflowStartUpdateOutput>>

Returns

Promise<WorkflowStartUpdateOutput>

Implementation of

WorkflowClientInterceptor.startUpdate


startUpdateWithStart

startUpdateWithStart(input, next): Promise<WorkflowStartUpdateWithStartOutput>

Parameters

NameType
inputWorkflowStartUpdateWithStartInput
nextOmitLastParam<(input: WorkflowStartUpdateWithStartInput, next: OmitLastParam<(input: WorkflowStartUpdateWithStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartUpdateWithStartOutput>>) => Promise<WorkflowStartUpdateWithStartOutput>>

Returns

Promise<WorkflowStartUpdateWithStartOutput>

Implementation of

WorkflowClientInterceptor.startUpdateWithStart


startWithDetails

startWithDetails(input, next): Promise<WorkflowStartOutput>

Parameters

NameType
inputWorkflowStartInput
nextOmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<(input: WorkflowStartInput, next: OmitLastParam<...>) => Promise<WorkflowStartOutput>>) => Promise<WorkflowStartOutput>>

Returns

Promise<WorkflowStartOutput>

Implementation of

WorkflowClientInterceptor.startWithDetails


terminate

terminate(input, next): Promise<ITerminateWorkflowExecutionResponse>

Parameters

NameType
inputWorkflowTerminateInput
nextOmitLastParam<(input: WorkflowTerminateInput, next: OmitLastParam<(input: WorkflowTerminateInput, next: OmitLastParam<...>) => Promise<ITerminateWorkflowExecutionResponse>>) => Promise<ITerminateWorkflowExecutionResponse>>

Returns

Promise<ITerminateWorkflowExecutionResponse>

Implementation of

WorkflowClientInterceptor.terminate