Package io.temporal.internal.client

Class CompletedWorkflowUpdateHandleImpl<T>

java.lang.Object

io.temporal.internal.client.CompletedWorkflowUpdateHandleImpl<T>

All Implemented Interfaces:

WorkflowUpdateHandle<T>

public final class CompletedWorkflowUpdateHandleImpl<T>
extends java.lang.Object
implements WorkflowUpdateHandle<T>

Constructor Summary

Constructors

Constructor	Description
CompletedWorkflowUpdateHandleImpl(java.lang.String id, io.temporal.api.common.v1.WorkflowExecution execution, WorkflowUpdateException ex)
CompletedWorkflowUpdateHandleImpl(java.lang.String id, io.temporal.api.common.v1.WorkflowExecution execution, T result)

Method Summary

Modifier and Type	Method	Description
io.temporal.api.common.v1.WorkflowExecution	getExecution()	Gets the workflow execution this update request was sent to.
java.lang.String	getId()	Gets the unique ID of this update.
T	getResult()	Returns the result of the workflow update.
T	getResult(long timeout, java.util.concurrent.TimeUnit unit)	Returns the result of the workflow update.
java.util.concurrent.CompletableFuture<T>	getResultAsync()	Returns a CompletableFuture with the update workflow execution request result, potentially waiting for the update to complete.
java.util.concurrent.CompletableFuture<T>	getResultAsync(long timeout, java.util.concurrent.TimeUnit unit)	Returns a CompletableFuture with the update workflow execution request result, potentially waiting for the update to complete.

Methods inherited from class java.lang.Object

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

Constructor Detail

CompletedWorkflowUpdateHandleImpl

public CompletedWorkflowUpdateHandleImpl(java.lang.String id,
                                         io.temporal.api.common.v1.WorkflowExecution execution,
                                         T result)

CompletedWorkflowUpdateHandleImpl

public CompletedWorkflowUpdateHandleImpl(java.lang.String id,
                                         io.temporal.api.common.v1.WorkflowExecution execution,
                                         WorkflowUpdateException ex)

Method Detail

getExecution

public io.temporal.api.common.v1.WorkflowExecution getExecution()

Description copied from interface: WorkflowUpdateHandle

Gets the workflow execution this update request was sent to.

Specified by:

getExecution in interface WorkflowUpdateHandle<T>

Returns:

the workflow execution this update was sent to.

getId

public java.lang.String getId()

Description copied from interface: WorkflowUpdateHandle

Gets the unique ID of this update.

Specified by:

getId in interface WorkflowUpdateHandle<T>

Returns:

the updates ID.

getResult

public T getResult()

Description copied from interface: WorkflowUpdateHandle

Returns the result of the workflow update.

Specified by:

getResult in interface WorkflowUpdateHandle<T>

Returns:

the result of the workflow update

getResult

public T getResult(long timeout,
                   java.util.concurrent.TimeUnit unit)

Description copied from interface: WorkflowUpdateHandle

Returns the result of the workflow update.

Specified by:

getResult in interface WorkflowUpdateHandle<T>

Parameters:

timeout - maximum time to wait and perform the background long polling

unit - unit of timeout

Returns:

the result of the workflow update

getResultAsync

public java.util.concurrent.CompletableFuture<T> getResultAsync()

Description copied from interface: WorkflowUpdateHandle

Returns a CompletableFuture with the update workflow execution request result, potentially waiting for the update to complete.

Specified by:

getResultAsync in interface WorkflowUpdateHandle<T>

Returns:

future completed with the result of the update or an exception

getResultAsync

public java.util.concurrent.CompletableFuture<T> getResultAsync(long timeout,
                                                                java.util.concurrent.TimeUnit unit)

Description copied from interface: WorkflowUpdateHandle

Returns a CompletableFuture with the update workflow execution request result, potentially waiting for the update to complete.

Specified by:

getResultAsync in interface WorkflowUpdateHandle<T>

Parameters:

timeout - maximum time to wait and perform the background long polling

unit - unit of timeout

Returns:

future completed with the result of the update or an exception