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)	Completes the activity execution successfully.
<R> void	complete(String workflowId, Optional<String> runId, String activityId, R result)	Completes the activity execution successfully.
void	completeExceptionally(byte[] taskToken, Exception result)	Completes the activity execution with failure.
void	completeExceptionally(String workflowId, Optional<String> runId, String activityId, Exception result)	Completes the activity execution with failure.
void	completeExceptionallyStandalone(String activityId, Optional<String> activityRunId, Exception result)	Completes a standalone activity execution with failure.
<R> void	completeStandalone(String activityId, Optional<String> activityRunId, R result)	Completes a standalone activity execution successfully.
<V> void	heartbeat(byte[] taskToken, V details)	Records a heartbeat for an activity.
<V> void	heartbeat(String workflowId, Optional<String> runId, String activityId, V details)	Records a heartbeat for an activity.
<V> void	heartbeatStandalone(String activityId, Optional<String> activityRunId, V details)	Records a heartbeat for a standalone activity.
<V> void	reportCancellation(byte[] taskToken, V details)	Confirms successful cancellation to the server.
<V> void	reportCancellation(String workflowId, Optional<String> runId, String activityId, V details)	Confirms successful cancellation to the server.
<V> void	reportCancellationStandalone(String activityId, Optional<String> activityRunId, V details)	Confirms successful cancellation of a standalone activity to the server.
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 Details

complete

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

Completes the activity execution successfully.

Parameters:

taskToken - token of the activity attempt to complete

result - of the activity execution

Throws:

ActivityCompletionException

complete

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

Completes the activity execution successfully.

This method is only for activities run within a workflow.

Parameters:

workflowId - id of the workflow that started the activity

runId - optional run id of the workflow that started the activity

activityId - id of the activity

result - of the activity execution

Throws:

ActivityCompletionException

completeStandalone

@Experimental
<R> void completeStandalone(String activityId,
 Optional<String> activityRunId,
 R result)
                     throws ActivityCompletionException

Completes a standalone activity execution successfully.

Use this overload for standalone activities (not started from a workflow). For workflow-scheduled activities, use complete(String, Optional, String, Object). To complete a standalone activity using a task token, use complete(byte[], Object).

Parameters:

activityId - id of the standalone activity

activityRunId - optional run id of the standalone activity, or Optional.empty()

result - of the activity execution

Throws:

ActivityCompletionException

completeExceptionally

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

Completes the activity execution with failure.

Parameters:

taskToken - token of the activity attempt to complete

result - the exception to be used as a failure details object

Throws:

ActivityCompletionException

completeExceptionally

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

Completes the activity execution with failure.

This method is only for activities run within a workflow.

Parameters:

workflowId - id of the workflow that started the activity

runId - optional run id of the workflow that started the activity

activityId - id of the activity

result - the exception to be used as a failure details object

Throws:

ActivityCompletionException

completeExceptionallyStandalone

@Experimental
void completeExceptionallyStandalone(String activityId,
 Optional<String> activityRunId,
 Exception result)
                              throws ActivityCompletionException

Completes a standalone activity execution with failure.

Use this overload for standalone activities (not started from a workflow). For workflow-scheduled activities, use completeExceptionally(String, Optional, String, Exception). To complete a standalone activity with failure using a task token, use completeExceptionally(byte[], Exception).

Parameters:

activityId - id of the standalone activity

activityRunId - optional run id of the standalone activity, or Optional.empty()

result - the exception to be used as a failure details object

Throws:

ActivityCompletionException

reportCancellation

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

Confirms successful cancellation to the server.

Parameters:

taskToken - token of the activity attempt

details - details to record with the cancellation

Throws:

ActivityCompletionException

reportCancellation

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

Confirms successful cancellation to the server.

This method is only for activities run within a workflow.

Parameters:

workflowId - id of the workflow that started the activity

runId - optional run id of the workflow that started the activity

activityId - id of the activity

details - details to record with the cancellation

Throws:

ActivityCompletionException

reportCancellationStandalone

@Experimental
<V> void reportCancellationStandalone(String activityId,
 Optional<String> activityRunId,
 V details)
                               throws ActivityCompletionException

Confirms successful cancellation of a standalone activity to the server.

Use this overload for standalone activities (not started from a workflow). For workflow-scheduled activities, use reportCancellation(String, Optional, String, Object). To confirm a successful cancellation of a standalone activity using a task token, use reportCancellation(byte[], Object).

Parameters:

activityId - id of the standalone activity

activityRunId - optional run id of the standalone activity, or Optional.empty()

details - details to record with the cancellation

Throws:

ActivityCompletionException

heartbeat

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

Records a heartbeat for an activity.

Parameters:

taskToken - token of the activity attempt

details - details to record with the heartbeat

Throws:

ActivityCompletionException - if activity should stop executing

heartbeat

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

Records a heartbeat for an activity.

This method is only for activities run within a workflow.

Parameters:

workflowId - id of the workflow that started the activity

runId - optional run id of the workflow that started the activity

activityId - id of the activity

details - details to record with the heartbeat

Throws:

ActivityCompletionException - if activity should stop executing

heartbeatStandalone

@Experimental
<V> void heartbeatStandalone(String activityId,
 Optional<String> activityRunId,
 V details)
                      throws ActivityCompletionException

Records a heartbeat for a standalone activity.

Use this overload for standalone activities (not started from a workflow). For workflow-scheduled activities, use heartbeat(String, Optional, String, Object). To record a heartbeeat for a standalone activity using a task token, use heartbeat(byte[], Object).

Parameters:

activityId - id of the standalone activity

activityRunId - optional run id of the standalone activity, or Optional.empty()

details - details to record with the heartbeat

Throws:

ActivityCompletionException - if activity should stop executing

withContext

@Experimental
@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