Package io.temporal.client

Interface ActivityCompletionClient

public interface ActivityCompletionClient

Used to complete asynchronously activities that called ActivityExecutionContext.doNotCompleteOnReturn().

Use WorkflowClient.newActivityCompletionClient() to create an instance.

Method Summary

Modifier and Type	Method	Description
<R> void	complete(byte[] taskToken, R result)
<R> void	complete(java.lang.String workflowId, java.util.Optional<java.lang.String> runId, java.lang.String activityId, R result)
void	completeExceptionally(byte[] taskToken, java.lang.Exception result)
void	completeExceptionally(java.lang.String workflowId, java.util.Optional<java.lang.String> runId, java.lang.String activityId, java.lang.Exception result)
<V> void	heartbeat(byte[] taskToken, V details)
<V> void	heartbeat(java.lang.String workflowId, java.util.Optional<java.lang.String> runId, java.lang.String activityId, V details)
<V> void	reportCancellation(byte[] taskToken, V details)
<V> void	reportCancellation(java.lang.String workflowId, java.util.Optional<java.lang.String> runId, java.lang.String activityId, V details)
ActivityCompletionClient	withContext(ActivitySerializationContext context)	Supply this context if correct serialization of activity heartbeats, results or other payloads requires DataConverter, PayloadConverter or PayloadCodec to be aware of ActivitySerializationContext.

Method Detail

complete

<R> void complete(byte[] taskToken,
                  R result)
           throws ActivityCompletionException

Throws:

ActivityCompletionException

complete

<R> void complete(java.lang.String workflowId,
                  java.util.Optional<java.lang.String> runId,
                  java.lang.String activityId,
                  R result)
           throws ActivityCompletionException

Throws:

ActivityCompletionException

completeExceptionally

void completeExceptionally(byte[] taskToken,
                           java.lang.Exception result)
                    throws ActivityCompletionException

Throws:

ActivityCompletionException

completeExceptionally

void completeExceptionally(java.lang.String workflowId,
                           java.util.Optional<java.lang.String> runId,
                           java.lang.String activityId,
                           java.lang.Exception result)
                    throws ActivityCompletionException

Throws:

ActivityCompletionException

reportCancellation

<V> void reportCancellation(byte[] taskToken,
                            V details)
                     throws ActivityCompletionException

Throws:

ActivityCompletionException

reportCancellation

<V> void reportCancellation(java.lang.String workflowId,
                            java.util.Optional<java.lang.String> runId,
                            java.lang.String activityId,
                            V details)
                     throws ActivityCompletionException

Throws:

ActivityCompletionException

heartbeat

<V> void heartbeat(byte[] taskToken,
                   V details)
            throws ActivityCompletionException

Throws:

ActivityCompletionException

heartbeat

<V> void heartbeat(java.lang.String workflowId,
                   java.util.Optional<java.lang.String> runId,
                   java.lang.String activityId,
                   V details)
            throws ActivityCompletionException

Throws:

ActivityCompletionException - if activity should stop executing

withContext

@Nonnull
ActivityCompletionClient withContext(@Nonnull
                                     ActivitySerializationContext context)

Supply this context if correct serialization of activity heartbeats, results or other payloads requires DataConverter, PayloadConverter or PayloadCodec to be aware of ActivitySerializationContext.

Parameters:

context - provides information to the data converter about the abstraction the data belongs to

Returns:

an instance of DataConverter that may use the provided context for serialization

See Also:

SerializationContext