Interface NexusClientCallsInterceptor

All Known Implementing Classes:

NexusClientCallsInterceptorBase, RootNexusClientInvoker

@Experimental
public interface NexusClientCallsInterceptor

Per-call interceptor for NexusClient and NexusOperationHandle operations on standalone Nexus operation executions.

Implementations are produced by NexusClientInterceptor.nexusClientCallsInterceptor(NexusClientCallsInterceptor) during NexusClient construction. Prefer extending NexusClientCallsInterceptorBase and overriding only the methods you need.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	NexusClientCallsInterceptor.CountNexusOperationExecutionsInput
static final class	NexusClientCallsInterceptor.CountNexusOperationExecutionsOutput
static final class	NexusClientCallsInterceptor.DeleteNexusOperationExecutionInput
static final class	NexusClientCallsInterceptor.DeleteNexusOperationExecutionOutput
static final class	NexusClientCallsInterceptor.DescribeNexusOperationExecutionInput
static final class	NexusClientCallsInterceptor.DescribeNexusOperationExecutionOutput
static final class	NexusClientCallsInterceptor.GetNexusOperationResultInput<R>
static final class	NexusClientCallsInterceptor.GetNexusOperationResultOutput<R>
static final class	NexusClientCallsInterceptor.ListNexusOperationExecutionsInput
static final class	NexusClientCallsInterceptor.ListNexusOperationExecutionsOutput	Result of a list call.
static final class	NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionInput
static final class	NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionOutput
static final class	NexusClientCallsInterceptor.StartNexusOperationExecutionInput
static final class	NexusClientCallsInterceptor.StartNexusOperationExecutionOutput
static final class	NexusClientCallsInterceptor.TerminateNexusOperationExecutionInput
static final class	NexusClientCallsInterceptor.TerminateNexusOperationExecutionOutput

Method Summary

Modifier and Type	Method	Description
NexusClientCallsInterceptor.CountNexusOperationExecutionsOutput	countNexusOperationExecutions(NexusClientCallsInterceptor.CountNexusOperationExecutionsInput input)	Returns the count of standalone Nexus operation executions matching a Visibility query, optionally grouped by attribute.
NexusClientCallsInterceptor.DeleteNexusOperationExecutionOutput	deleteNexusOperationExecution(NexusClientCallsInterceptor.DeleteNexusOperationExecutionInput input)	Deletes a closed standalone Nexus operation execution from the server's visibility store.
NexusClientCallsInterceptor.DescribeNexusOperationExecutionOutput	describeNexusOperationExecution(NexusClientCallsInterceptor.DescribeNexusOperationExecutionInput input)	Returns a point-in-time snapshot of a standalone Nexus operation execution.
<R> NexusClientCallsInterceptor.GetNexusOperationResultOutput<R>	getNexusOperationResult(NexusClientCallsInterceptor.GetNexusOperationResultInput<R> input)	Synchronously waits for a standalone Nexus operation to complete and returns the deserialized result.
<R> CompletableFuture<NexusClientCallsInterceptor.GetNexusOperationResultOutput<R>>	getNexusOperationResultAsync(NexusClientCallsInterceptor.GetNexusOperationResultInput<R> input)	Asynchronous variant of getNexusOperationResult(io.temporal.common.interceptors.NexusClientCallsInterceptor.GetNexusOperationResultInput<R>) that returns a future without blocking the calling thread.
NexusClientCallsInterceptor.ListNexusOperationExecutionsOutput	listNexusOperationExecutions(NexusClientCallsInterceptor.ListNexusOperationExecutionsInput input)	Lists standalone Nexus operation executions matching a Visibility query.
NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionOutput	requestCancelNexusOperationExecution(NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionInput input)	Requests cancellation of a running standalone Nexus operation.
NexusClientCallsInterceptor.StartNexusOperationExecutionOutput	startNexusOperationExecution(NexusClientCallsInterceptor.StartNexusOperationExecutionInput input)	Starts a standalone Nexus operation.
NexusClientCallsInterceptor.TerminateNexusOperationExecutionOutput	terminateNexusOperationExecution(NexusClientCallsInterceptor.TerminateNexusOperationExecutionInput input)	Forcefully terminates a standalone Nexus operation.

Method Details

startNexusOperationExecution

NexusClientCallsInterceptor.StartNexusOperationExecutionOutput startNexusOperationExecution(NexusClientCallsInterceptor.StartNexusOperationExecutionInput input)

Starts a standalone Nexus operation. The endpoint, service, operation name, input, and scheduling options are carried in input.

Parameters:

input - endpoint, service name, operation name, encoded input, and start options

Returns:

output containing the operation ID, server-assigned run ID, and whether the operation was started by this call (vs. de-duplicated to an existing one)

describeNexusOperationExecution

NexusClientCallsInterceptor.DescribeNexusOperationExecutionOutput describeNexusOperationExecution(NexusClientCallsInterceptor.DescribeNexusOperationExecutionInput input)

Returns a point-in-time snapshot of a standalone Nexus operation execution.

Parameters:

input - operation ID and optional run ID

Returns:

output wrapping the NexusOperationExecutionDescription

getNexusOperationResult

<R>
NexusClientCallsInterceptor.GetNexusOperationResultOutput<R> getNexusOperationResult(NexusClientCallsInterceptor.GetNexusOperationResultInput<R> input)
                                                                              throws TimeoutException

Synchronously waits for a standalone Nexus operation to complete and returns the deserialized result. Implementations own the poll loop, deadline enforcement, and Payload → R deserialization. Blocks the calling thread for the duration.

If you implement this method, getNexusOperationResultAsync(io.temporal.common.interceptors.NexusClientCallsInterceptor.GetNexusOperationResultInput<R>) most likely needs to be implemented too.

Type Parameters:

R - the expected result type

Parameters:

input - operation ID, optional run ID, deadline, and the expected result class and type

Returns:

output wrapping the deserialized result

Throws:

NexusOperationFailedException - if the operation completed with a failure

TimeoutException - if the deadline expires before the operation completes

See Also:

• getNexusOperationResultAsync(io.temporal.common.interceptors.NexusClientCallsInterceptor.GetNexusOperationResultInput<R>)

getNexusOperationResultAsync

<R>
CompletableFuture<NexusClientCallsInterceptor.GetNexusOperationResultOutput<R>> getNexusOperationResultAsync(NexusClientCallsInterceptor.GetNexusOperationResultInput<R> input)

Asynchronous variant of getNexusOperationResult(io.temporal.common.interceptors.NexusClientCallsInterceptor.GetNexusOperationResultInput<R>) that returns a future without blocking the calling thread.

If you implement this method, getNexusOperationResult(io.temporal.common.interceptors.NexusClientCallsInterceptor.GetNexusOperationResultInput<R>) most likely needs to be implemented too.

Type Parameters:

R - the expected result type

Parameters:

input - operation ID, optional run ID, deadline, and the expected result class and type

Returns:

a future that completes with the deserialized result, or completes exceptionally with NexusOperationFailedException on failure or TimeoutException on deadline expiry

See Also:

• getNexusOperationResult(io.temporal.common.interceptors.NexusClientCallsInterceptor.GetNexusOperationResultInput<R>)

listNexusOperationExecutions

NexusClientCallsInterceptor.ListNexusOperationExecutionsOutput listNexusOperationExecutions(NexusClientCallsInterceptor.ListNexusOperationExecutionsInput input)

Lists standalone Nexus operation executions matching a Visibility query. The returned output contains a lazy Stream of deserialized NexusOperationExecutionMetadata objects; pages are fetched on demand as the stream is consumed.

Parameters:

input - Visibility query string

Returns:

output wrapping a lazy stream of matching operations

countNexusOperationExecutions

NexusClientCallsInterceptor.CountNexusOperationExecutionsOutput countNexusOperationExecutions(NexusClientCallsInterceptor.CountNexusOperationExecutionsInput input)

Returns the count of standalone Nexus operation executions matching a Visibility query, optionally grouped by attribute.

Parameters:

input - Visibility query string

Returns:

output wrapping the total count and any aggregation groups

requestCancelNexusOperationExecution

NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionOutput requestCancelNexusOperationExecution(NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionInput input)

Requests cancellation of a running standalone Nexus operation. The server forwards the cancel request to the operation handler, which may honour or ignore it.

Parameters:

input - operation ID, optional run ID, and optional human-readable cancellation reason

Returns:

an empty output that exists so the call can carry fields in the future

terminateNexusOperationExecution

NexusClientCallsInterceptor.TerminateNexusOperationExecutionOutput terminateNexusOperationExecution(NexusClientCallsInterceptor.TerminateNexusOperationExecutionInput input)

Forcefully terminates a standalone Nexus operation. Unlike cancellation, termination is immediate and cannot be intercepted by the operation handler.

Parameters:

input - operation ID, optional run ID, and optional human-readable termination reason

Returns:

an empty output that exists so the call can carry fields in the future

deleteNexusOperationExecution

NexusClientCallsInterceptor.DeleteNexusOperationExecutionOutput deleteNexusOperationExecution(NexusClientCallsInterceptor.DeleteNexusOperationExecutionInput input)

Deletes a closed standalone Nexus operation execution from the server's visibility store. The operation must already be in a terminal state.

Parameters:

input - operation ID and optional run ID

Returns:

an empty output that exists so the call can carry fields in the future