Class NexusClientCallsInterceptorBase

java.lang.Object

io.temporal.common.interceptors.NexusClientCallsInterceptorBase

All Implemented Interfaces:

NexusClientCallsInterceptor

@Experimental
public class NexusClientCallsInterceptorBase
extends Object
implements NexusClientCallsInterceptor

Convenience base class for NexusClientCallsInterceptor implementations that need to override only a subset of methods. All methods delegate to the wrapped next interceptor.

Nested Class Summary

Nested classes/interfaces inherited from interface io.temporal.common.interceptors.NexusClientCallsInterceptor

NexusClientCallsInterceptor.CountNexusOperationExecutionsInput, NexusClientCallsInterceptor.CountNexusOperationExecutionsOutput, NexusClientCallsInterceptor.DeleteNexusOperationExecutionInput, NexusClientCallsInterceptor.DeleteNexusOperationExecutionOutput, NexusClientCallsInterceptor.DescribeNexusOperationExecutionInput, NexusClientCallsInterceptor.DescribeNexusOperationExecutionOutput, NexusClientCallsInterceptor.GetNexusOperationResultInput<R>, NexusClientCallsInterceptor.GetNexusOperationResultOutput<R>, NexusClientCallsInterceptor.ListNexusOperationExecutionsInput, NexusClientCallsInterceptor.ListNexusOperationExecutionsOutput, NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionInput, NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionOutput, NexusClientCallsInterceptor.StartNexusOperationExecutionInput, NexusClientCallsInterceptor.StartNexusOperationExecutionOutput, NexusClientCallsInterceptor.TerminateNexusOperationExecutionInput, NexusClientCallsInterceptor.TerminateNexusOperationExecutionOutput

Constructor Summary

Constructors

Constructor	Description
NexusClientCallsInterceptorBase(NexusClientCallsInterceptor next)

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NexusClientCallsInterceptorBase

public NexusClientCallsInterceptorBase(NexusClientCallsInterceptor next)

Method Details

startNexusOperationExecution

public NexusClientCallsInterceptor.StartNexusOperationExecutionOutput startNexusOperationExecution(NexusClientCallsInterceptor.StartNexusOperationExecutionInput input)

Description copied from interface: NexusClientCallsInterceptor

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

Specified by:

startNexusOperationExecution in interface NexusClientCallsInterceptor

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

public NexusClientCallsInterceptor.DescribeNexusOperationExecutionOutput describeNexusOperationExecution(NexusClientCallsInterceptor.DescribeNexusOperationExecutionInput input)

Description copied from interface: NexusClientCallsInterceptor

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

Specified by:

describeNexusOperationExecution in interface NexusClientCallsInterceptor

Parameters:

input - operation ID and optional run ID

Returns:

output wrapping the NexusOperationExecutionDescription

getNexusOperationResult

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

Description copied from interface: NexusClientCallsInterceptor

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, NexusClientCallsInterceptor.getNexusOperationResultAsync(io.temporal.common.interceptors.NexusClientCallsInterceptor.GetNexusOperationResultInput<R>) most likely needs to be implemented too.

Specified by:

getNexusOperationResult in interface NexusClientCallsInterceptor

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:

TimeoutException - if the deadline expires before the operation completes

See Also:

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

getNexusOperationResultAsync

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

Description copied from interface: NexusClientCallsInterceptor

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

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

Specified by:

getNexusOperationResultAsync in interface NexusClientCallsInterceptor

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:

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

listNexusOperationExecutions

public NexusClientCallsInterceptor.ListNexusOperationExecutionsOutput listNexusOperationExecutions(NexusClientCallsInterceptor.ListNexusOperationExecutionsInput input)

Description copied from interface: NexusClientCallsInterceptor

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.

Specified by:

listNexusOperationExecutions in interface NexusClientCallsInterceptor

Parameters:

input - Visibility query string

Returns:

output wrapping a lazy stream of matching operations

countNexusOperationExecutions

public NexusClientCallsInterceptor.CountNexusOperationExecutionsOutput countNexusOperationExecutions(NexusClientCallsInterceptor.CountNexusOperationExecutionsInput input)

Description copied from interface: NexusClientCallsInterceptor

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

Specified by:

countNexusOperationExecutions in interface NexusClientCallsInterceptor

Parameters:

input - Visibility query string

Returns:

output wrapping the total count and any aggregation groups

requestCancelNexusOperationExecution

public NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionOutput requestCancelNexusOperationExecution(NexusClientCallsInterceptor.RequestCancelNexusOperationExecutionInput input)

Description copied from interface: NexusClientCallsInterceptor

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

Specified by:

requestCancelNexusOperationExecution in interface NexusClientCallsInterceptor

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

public NexusClientCallsInterceptor.TerminateNexusOperationExecutionOutput terminateNexusOperationExecution(NexusClientCallsInterceptor.TerminateNexusOperationExecutionInput input)

Description copied from interface: NexusClientCallsInterceptor

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

Specified by:

terminateNexusOperationExecution in interface NexusClientCallsInterceptor

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

public NexusClientCallsInterceptor.DeleteNexusOperationExecutionOutput deleteNexusOperationExecution(NexusClientCallsInterceptor.DeleteNexusOperationExecutionInput input)

Description copied from interface: NexusClientCallsInterceptor

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

Specified by:

deleteNexusOperationExecution in interface NexusClientCallsInterceptor

Parameters:

input - operation ID and optional run ID

Returns:

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