Class NexusOperationHandleImpl

java.lang.Object

io.temporal.internal.client.NexusOperationHandleImpl

All Implemented Interfaces:

UntypedNexusOperationHandle

public final class NexusOperationHandleImpl
extends Object
implements UntypedNexusOperationHandle

Implementation of UntypedNexusOperationHandle that delegates lifecycle operations through the interceptor chain.

Constructor Summary

Constructors

Constructor	Description
NexusOperationHandleImpl(String operationId, String runId, NexusClientCallsInterceptor interceptor)

Method Summary

Modifier and Type	Method	Description
void	cancel()	Requests cancellation of the Nexus operation.
void	cancel(String reason)	Requests cancellation of the Nexus operation with an optional reason.
NexusOperationExecutionDescription	describe()	Describes the current state of the Nexus operation execution.
String	getNexusOperationId()	The caller-assigned operation ID for this execution.
String	getNexusOperationRunId()	The server-assigned run ID for this operation execution.
<R> R	getResult(long timeout, TimeUnit unit, Class<R> resultClass)	Blocks until the standalone Nexus operation completes and returns the typed result, or throws if the client-side timeout expires before the operation completes.
<R> R	getResult(long timeout, TimeUnit unit, Class<R> resultClass, Type resultType)	Blocks until the standalone Nexus operation completes and returns the typed result, or throws if the client-side timeout expires.
<R> R	getResult(Class<R> resultClass)	Blocks until the standalone Nexus operation completes and returns the typed result.
<R> R	getResult(Class<R> resultClass, Type resultType)	Blocks until the standalone Nexus operation completes and returns the typed result.
<R> CompletableFuture<R>	getResultAsync(long timeout, TimeUnit unit, Class<R> resultClass)	Returns a future that completes when the operation completes, or fails with TimeoutException if the operation does not complete within the specified timeout.
<R> CompletableFuture<R>	getResultAsync(long timeout, TimeUnit unit, Class<R> resultClass, Type resultType)	Returns a future for generic return types with a timeout.
<R> CompletableFuture<R>	getResultAsync(Class<R> resultClass)	Returns a future that completes when the operation completes and resolves to the typed result.
<R> CompletableFuture<R>	getResultAsync(Class<R> resultClass, Type resultType)	Returns a future that completes when the operation completes and resolves to the typed result.
void	terminate()	Terminates the Nexus operation immediately, regardless of its current state.
void	terminate(String reason)	Terminates the Nexus operation immediately with a reason.

Methods inherited from class java.lang.Object

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

Constructor Details

NexusOperationHandleImpl

public NexusOperationHandleImpl(String operationId,
 @Nullable
 String runId,
 NexusClientCallsInterceptor interceptor)

Method Details

getNexusOperationId

public String getNexusOperationId()

Description copied from interface: UntypedNexusOperationHandle

The caller-assigned operation ID for this execution. Always non-null.

Specified by:

getNexusOperationId in interface UntypedNexusOperationHandle

getNexusOperationRunId

@Nullable
public String getNexusOperationRunId()

Description copied from interface: UntypedNexusOperationHandle

The server-assigned run ID for this operation execution. Present when the handle was returned by start or when NexusClient.getHandle(String, String) was called with an explicit run ID.

Specified by:

getNexusOperationRunId in interface UntypedNexusOperationHandle

describe

public NexusOperationExecutionDescription describe()

Description copied from interface: UntypedNexusOperationHandle

Describes the current state of the Nexus operation execution.

Specified by:

describe in interface UntypedNexusOperationHandle

Returns:

detailed information about the operation

cancel

public void cancel()

Description copied from interface: UntypedNexusOperationHandle

Requests cancellation of the Nexus operation.

Specified by:

cancel in interface UntypedNexusOperationHandle

cancel

public void cancel(@Nullable
 String reason)

Description copied from interface: UntypedNexusOperationHandle

Requests cancellation of the Nexus operation with an optional reason.

Specified by:

cancel in interface UntypedNexusOperationHandle

Parameters:

reason - human-readable reason for cancellation, may be null

terminate

public void terminate()

Description copied from interface: UntypedNexusOperationHandle

Terminates the Nexus operation immediately, regardless of its current state.

Specified by:

terminate in interface UntypedNexusOperationHandle

terminate

public void terminate(@Nullable
 String reason)

Description copied from interface: UntypedNexusOperationHandle

Terminates the Nexus operation immediately with a reason.

Specified by:

terminate in interface UntypedNexusOperationHandle

Parameters:

reason - human-readable reason for termination, may be null

getResult

public <R> R getResult(Class<R> resultClass)

Description copied from interface: UntypedNexusOperationHandle

Blocks until the standalone Nexus operation completes and returns the typed result. Polls the server via long-polling.

Specified by:

getResult in interface UntypedNexusOperationHandle

Parameters:

resultClass - the class to deserialize the result into

getResult

public <R> R getResult(Class<R> resultClass,
 @Nullable
 Type resultType)

Description copied from interface: UntypedNexusOperationHandle

Blocks until the standalone Nexus operation completes and returns the typed result. Use this overload for generic return types (e.g. List<String>).

Specified by:

getResult in interface UntypedNexusOperationHandle

Parameters:

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null

getResultAsync

public <R> CompletableFuture<R> getResultAsync(Class<R> resultClass)

Description copied from interface: UntypedNexusOperationHandle

Returns a future that completes when the operation completes and resolves to the typed result.

Specified by:

getResultAsync in interface UntypedNexusOperationHandle

Parameters:

resultClass - the class to deserialize the result into

getResultAsync

public <R> CompletableFuture<R> getResultAsync(Class<R> resultClass,
 @Nullable
 Type resultType)

Description copied from interface: UntypedNexusOperationHandle

Returns a future that completes when the operation completes and resolves to the typed result. Use this overload for generic return types (e.g. List<String>).

Specified by:

getResultAsync in interface UntypedNexusOperationHandle

Parameters:

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null

getResult

public <R> R getResult(long timeout,
 TimeUnit unit,
 Class<R> resultClass)
                throws TimeoutException

Description copied from interface: UntypedNexusOperationHandle

Blocks until the standalone Nexus operation completes and returns the typed result, or throws if the client-side timeout expires before the operation completes.

Specified by:

getResult in interface UntypedNexusOperationHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

Throws:

TimeoutException - if the client-side timeout expires before the operation completes

getResult

public <R> R getResult(long timeout,
 TimeUnit unit,
 Class<R> resultClass,
 @Nullable
 Type resultType)
                throws TimeoutException

Description copied from interface: UntypedNexusOperationHandle

Blocks until the standalone Nexus operation completes and returns the typed result, or throws if the client-side timeout expires. Use this overload for generic return types (e.g. List<String>).

Specified by:

getResult in interface UntypedNexusOperationHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null

Throws:

TimeoutException - if the client-side timeout expires before the operation completes

getResultAsync

public <R> CompletableFuture<R> getResultAsync(long timeout,
 TimeUnit unit,
 Class<R> resultClass)

Description copied from interface: UntypedNexusOperationHandle

Returns a future that completes when the operation completes, or fails with TimeoutException if the operation does not complete within the specified timeout.

Specified by:

getResultAsync in interface UntypedNexusOperationHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

getResultAsync

public <R> CompletableFuture<R> getResultAsync(long timeout,
 TimeUnit unit,
 Class<R> resultClass,
 @Nullable
 Type resultType)

Description copied from interface: UntypedNexusOperationHandle

Returns a future for generic return types with a timeout.

Specified by:

getResultAsync in interface UntypedNexusOperationHandle

Parameters:

timeout - maximum time to wait

unit - unit of timeout

resultClass - the class to deserialize the result into

resultType - the generic type to use for deserialization; may be null