Interface WorkflowClientCallsInterceptor

All Known Implementing Classes:

RootWorkflowClientInvoker, WorkflowClientCallsInterceptorBase

@Experimental
public interface WorkflowClientCallsInterceptor

Intercepts calls to the WorkflowClient related to the lifecycle of a Workflow.

Prefer extending WorkflowClientCallsInterceptorBase and overriding only the methods you need instead of implementing this interface directly. WorkflowClientCallsInterceptorBase provides correct default implementations to all the methods of this interface.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	WorkflowClientCallsInterceptor.CancelInput
static final class	WorkflowClientCallsInterceptor.CancelOutput
static final class	WorkflowClientCallsInterceptor.CountWorkflowOutput
static final class	WorkflowClientCallsInterceptor.CountWorkflowsInput
static final class	WorkflowClientCallsInterceptor.DescribeWorkflowInput
static final class	WorkflowClientCallsInterceptor.DescribeWorkflowOutput
static final class	WorkflowClientCallsInterceptor.GetResultAsyncOutput<R>
static final class	WorkflowClientCallsInterceptor.GetResultInput<R>
static final class	WorkflowClientCallsInterceptor.GetResultOutput<R>
static final class	WorkflowClientCallsInterceptor.ListWorkflowExecutionsInput
static final class	WorkflowClientCallsInterceptor.ListWorkflowExecutionsOutput
static final class	WorkflowClientCallsInterceptor.PollWorkflowUpdateInput<R>
static final class	WorkflowClientCallsInterceptor.PollWorkflowUpdateOutput<R>
static final class	WorkflowClientCallsInterceptor.QueryInput<R>
static final class	WorkflowClientCallsInterceptor.QueryOutput<R>
static final class	WorkflowClientCallsInterceptor.StartUpdateInput<R>
static final class	WorkflowClientCallsInterceptor.TerminateInput
static final class	WorkflowClientCallsInterceptor.TerminateOutput
static final class	WorkflowClientCallsInterceptor.WorkflowSignalInput
static final class	WorkflowClientCallsInterceptor.WorkflowSignalOutput
static final class	WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput
static final class	WorkflowClientCallsInterceptor.WorkflowSignalWithStartOutput
static final class	WorkflowClientCallsInterceptor.WorkflowStartInput
static final class	WorkflowClientCallsInterceptor.WorkflowStartOutput
static final class	WorkflowClientCallsInterceptor.WorkflowUpdateWithStartInput<R>
static final class	WorkflowClientCallsInterceptor.WorkflowUpdateWithStartOutput<R>

Method Summary

Modifier and Type	Method	Description
WorkflowClientCallsInterceptor.CancelOutput	cancel(WorkflowClientCallsInterceptor.CancelInput input)
WorkflowClientCallsInterceptor.CountWorkflowOutput	countWorkflows(WorkflowClientCallsInterceptor.CountWorkflowsInput input)
WorkflowClientCallsInterceptor.DescribeWorkflowOutput	describe(WorkflowClientCallsInterceptor.DescribeWorkflowInput input)
<R> WorkflowClientCallsInterceptor.GetResultOutput<R>	getResult(WorkflowClientCallsInterceptor.GetResultInput<R> input)	If you implement this method, getResultAsync(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.
<R> WorkflowClientCallsInterceptor.GetResultAsyncOutput<R>	getResultAsync(WorkflowClientCallsInterceptor.GetResultInput<R> input)	If you implement this method, getResult(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.
WorkflowClientCallsInterceptor.ListWorkflowExecutionsOutput	listWorkflowExecutions(WorkflowClientCallsInterceptor.ListWorkflowExecutionsInput input)
<R> WorkflowClientCallsInterceptor.PollWorkflowUpdateOutput<R>	pollWorkflowUpdate(WorkflowClientCallsInterceptor.PollWorkflowUpdateInput<R> input)
<R> WorkflowClientCallsInterceptor.QueryOutput<R>	query(WorkflowClientCallsInterceptor.QueryInput<R> input)
WorkflowClientCallsInterceptor.WorkflowSignalOutput	signal(WorkflowClientCallsInterceptor.WorkflowSignalInput input)	If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) most likely needs to be implemented too.
WorkflowClientCallsInterceptor.WorkflowSignalWithStartOutput	signalWithStart(WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput input)
WorkflowClientCallsInterceptor.WorkflowStartOutput	start(WorkflowClientCallsInterceptor.WorkflowStartInput input)	If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) and @{link #updateWithStart} most likely need to be implemented too.
<R> WorkflowUpdateHandle<R>	startUpdate(WorkflowClientCallsInterceptor.StartUpdateInput<R> input)
WorkflowClientCallsInterceptor.TerminateOutput	terminate(WorkflowClientCallsInterceptor.TerminateInput input)
<R> WorkflowClientCallsInterceptor.WorkflowUpdateWithStartOutput<R>	updateWithStart(WorkflowClientCallsInterceptor.WorkflowUpdateWithStartInput<R> input)	Intercepts calls from WorkflowStub.startUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) and WorkflowStub.executeUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) as well as WorkflowClient.startUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>) and WorkflowClient.executeUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>).

Method Details

start

WorkflowClientCallsInterceptor.WorkflowStartOutput start(WorkflowClientCallsInterceptor.WorkflowStartInput input)

If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) and @{link #updateWithStart} most likely need to be implemented too.

See Also:

• signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput)

signal

WorkflowClientCallsInterceptor.WorkflowSignalOutput signal(WorkflowClientCallsInterceptor.WorkflowSignalInput input)

If you implement this method, signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput) most likely needs to be implemented too.

See Also:

• signalWithStart(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput)

signalWithStart

WorkflowClientCallsInterceptor.WorkflowSignalWithStartOutput signalWithStart(WorkflowClientCallsInterceptor.WorkflowSignalWithStartInput input)

updateWithStart

@Experimental
<R>
WorkflowClientCallsInterceptor.WorkflowUpdateWithStartOutput<R> updateWithStart(WorkflowClientCallsInterceptor.WorkflowUpdateWithStartInput<R> input)

Intercepts calls from WorkflowStub.startUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) and WorkflowStub.executeUpdateWithStart(io.temporal.client.UpdateOptions<R>, java.lang.Object[], java.lang.Object[]) as well as WorkflowClient.startUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>) and WorkflowClient.executeUpdateWithStart(io.temporal.workflow.Functions.Proc, io.temporal.client.UpdateOptions<R>, io.temporal.client.WithStartWorkflowOperation<?>).

getResult

<R>
WorkflowClientCallsInterceptor.GetResultOutput<R> getResult(WorkflowClientCallsInterceptor.GetResultInput<R> input)
                                                     throws TimeoutException

If you implement this method, getResultAsync(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.

Throws:

TimeoutException

See Also:

• getResultAsync(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>)

getResultAsync

<R>
WorkflowClientCallsInterceptor.GetResultAsyncOutput<R> getResultAsync(WorkflowClientCallsInterceptor.GetResultInput<R> input)

If you implement this method, getResult(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>) most likely needs to be implemented too.

See Also:

• getResult(io.temporal.common.interceptors.WorkflowClientCallsInterceptor.GetResultInput<R>)

query

<R> WorkflowClientCallsInterceptor.QueryOutput<R> query(WorkflowClientCallsInterceptor.QueryInput<R> input)

startUpdate

<R> WorkflowUpdateHandle<R> startUpdate(WorkflowClientCallsInterceptor.StartUpdateInput<R> input)

pollWorkflowUpdate

<R>
WorkflowClientCallsInterceptor.PollWorkflowUpdateOutput<R> pollWorkflowUpdate(WorkflowClientCallsInterceptor.PollWorkflowUpdateInput<R> input)

cancel

WorkflowClientCallsInterceptor.CancelOutput cancel(WorkflowClientCallsInterceptor.CancelInput input)

terminate

WorkflowClientCallsInterceptor.TerminateOutput terminate(WorkflowClientCallsInterceptor.TerminateInput input)

describe

WorkflowClientCallsInterceptor.DescribeWorkflowOutput describe(WorkflowClientCallsInterceptor.DescribeWorkflowInput input)

listWorkflowExecutions

WorkflowClientCallsInterceptor.ListWorkflowExecutionsOutput listWorkflowExecutions(WorkflowClientCallsInterceptor.ListWorkflowExecutionsInput input)

countWorkflows

WorkflowClientCallsInterceptor.CountWorkflowOutput countWorkflows(WorkflowClientCallsInterceptor.CountWorkflowsInput input)