Class WorkflowImplementationOptions.Builder

java.lang.Object

io.temporal.worker.WorkflowImplementationOptions.Builder

Enclosing class:

WorkflowImplementationOptions

public static final class WorkflowImplementationOptions.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
WorkflowImplementationOptions	build()
WorkflowImplementationOptions.Builder	setActivityOptions(Map<String,ActivityOptions> activityOptions)	Set individual activity options per activityType.
WorkflowImplementationOptions.Builder	setDefaultActivityOptions(ActivityOptions defaultActivityOptions)	These activity options have the lowest precedence across all activity options.
WorkflowImplementationOptions.Builder	setDefaultLocalActivityOptions(LocalActivityOptions defaultLocalActivityOptions)	These local activity options have the lowest precedence across all local activity options.
WorkflowImplementationOptions.Builder	setDefaultNexusServiceOptions(NexusServiceOptions defaultNexusServiceOptions)	These nexus service options to use if no specific options are passed for a service.
WorkflowImplementationOptions.Builder	setEnableUpsertVersionSearchAttributes(boolean enableUpsertVersionSearchAttributes)	Enable upserting version search attributes on Workflow.getVersion(java.lang.String, int, int).
final WorkflowImplementationOptions.Builder	setFailWorkflowExceptionTypes(Class<? extends Throwable>... failWorkflowExceptionTypes)	Optional: Sets how workflow worker deals with exceptions thrown from the workflow code which include non-deterministic history events (presumably arising from non-deterministic workflow definitions or non-backward compatible workflow definition changes).
WorkflowImplementationOptions.Builder	setLocalActivityOptions(Map<String,LocalActivityOptions> localActivityOptions)	Set individual local activity options per activityType.
WorkflowImplementationOptions.Builder	setNexusServiceOptions(Map<String,NexusServiceOptions> nexusServiceOptions)	Set individual Nexus Service options per service.

Methods inherited from class java.lang.Object

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

Method Details

setFailWorkflowExceptionTypes

@SafeVarargs
public final WorkflowImplementationOptions.Builder setFailWorkflowExceptionTypes(Class<? extends Throwable>... failWorkflowExceptionTypes)

Optional: Sets how workflow worker deals with exceptions thrown from the workflow code which include non-deterministic history events (presumably arising from non-deterministic workflow definitions or non-backward compatible workflow definition changes).

The default behavior is to fail workflow on TemporalFailure or any of its subclasses. Any other exceptions thrown from the workflow code are treated as bugs that can be fixed by a new deployment. So workflow is not failed, but it stuck in a retry loop trying to execute the code that led to the unexpected exception.

This option allows to specify specific exception types which should lead to workflow failure instead of blockage. Any exception that extends the configured type considered matched. For example to fail workflow on any exception pass Throwable class to this method.

setActivityOptions

public WorkflowImplementationOptions.Builder setActivityOptions(Map<String,ActivityOptions> activityOptions)

Set individual activity options per activityType. Will be merged with the map from Workflow.newActivityStub(Class, ActivityOptions, Map) which has the highest precedence.

Parameters:

activityOptions - map from activityType to ActivityOptions

setDefaultActivityOptions

public WorkflowImplementationOptions.Builder setDefaultActivityOptions(ActivityOptions defaultActivityOptions)

These activity options have the lowest precedence across all activity options. Will be overwritten entirely by Workflow.newActivityStub(Class, ActivityOptions) and then by the individual activity options if any are set through setActivityOptions(Map)

Parameters:

defaultActivityOptions - ActivityOptions for all activities in the workflow.

setLocalActivityOptions

public WorkflowImplementationOptions.Builder setLocalActivityOptions(Map<String,LocalActivityOptions> localActivityOptions)

Set individual local activity options per activityType. Will be merged with the map from Workflow.newLocalActivityStub(Class, LocalActivityOptions, Map) which has the highest precedence.

Parameters:

localActivityOptions - map from activityType to ActivityOptions

setDefaultLocalActivityOptions

public WorkflowImplementationOptions.Builder setDefaultLocalActivityOptions(LocalActivityOptions defaultLocalActivityOptions)

These local activity options have the lowest precedence across all local activity options. Will be overwritten entirely by Workflow.newLocalActivityStub(Class, LocalActivityOptions) and then by the individual local activity options if any are set through setLocalActivityOptions(Map)

Parameters:

defaultLocalActivityOptions - ActivityOptions for all activities in the workflow.

setNexusServiceOptions

public WorkflowImplementationOptions.Builder setNexusServiceOptions(Map<String,NexusServiceOptions> nexusServiceOptions)

Set individual Nexus Service options per service. Will be merged with the map from Workflow.newNexusServiceStub(Class, NexusServiceOptions) which has the highest precedence.

Parameters:

nexusServiceOptions - map from service to NexusServiceOptions

setDefaultNexusServiceOptions

public WorkflowImplementationOptions.Builder setDefaultNexusServiceOptions(NexusServiceOptions defaultNexusServiceOptions)

These nexus service options to use if no specific options are passed for a service. Will be used for a stub created with Workflow.newNexusServiceStub(Class)

Parameters:

defaultNexusServiceOptions - default NexusServiceOptions for all services in the workflow.

setEnableUpsertVersionSearchAttributes

@Experimental
public WorkflowImplementationOptions.Builder setEnableUpsertVersionSearchAttributes(boolean enableUpsertVersionSearchAttributes)

Enable upserting version search attributes on Workflow.getVersion(java.lang.String, int, int). This will cause the SDK to automatically add the TemporalChangeVersion search attributes to the workflow when getVersion is called. This search attribute is a keyword list of all the getVersion calls made in the workflow. The format of each entry is "-". This allows for easy discovery of what versions are being used in your namespace.

Note: This change is backwards compatible, so it is safe to enable or disable this options with running workflows. However, if this options is enabled, it is not safe to rollback to a previous version of the SDK that does not support this option.

The default value is false. This may change in future releases.

build

public WorkflowImplementationOptions build()