io.temporal.worker

Class WorkerOptions.Builder

java.lang.Object

io.temporal.worker.WorkerOptions.Builder

Enclosing class:

WorkerOptions

public static final class WorkerOptions.Builder
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
WorkerOptions	build()
WorkerOptions.Builder	setActivityPollThreadCount(int activityPollThreadCount) Number of simultaneous poll requests on activity task queue.
WorkerOptions.Builder	setLocalActivityWorkerOnly(boolean localActivityWorkerOnly) If set to true worker would only handle workflow tasks and local activities.
WorkerOptions.Builder	setMaxConcurrentActivityExecutionSize(int maxConcurrentActivityExecutionSize) Maximum number of parallely executed activities.
WorkerOptions.Builder	setMaxConcurrentLocalActivityExecutionSize(int maxConcurrentLocalActivityExecutionSize) Maximum number of parallely executed local activities.
WorkerOptions.Builder	setMaxConcurrentWorkflowTaskExecutionSize(int maxConcurrentWorkflowTaskExecutionSize) Maximum number of simultaneously executed workflow tasks.
WorkerOptions.Builder	setMaxTaskQueueActivitiesPerSecond(double maxTaskQueueActivitiesPerSecond) Optional: Sets the rate limiting on number of activities that can be executed per second.
WorkerOptions.Builder	setMaxWorkerActivitiesPerSecond(double maxWorkerActivitiesPerSecond) Maximum number of activities started per second by this worker.
WorkerOptions.Builder	setWorkflowPollThreadCount(int workflowPollThreadCount) Number of simultaneous poll requests on workflow task queue.
WorkerOptions	validateAndBuildWithDefaults()

Methods inherited from class java.lang.Object

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

Method Detail

setMaxWorkerActivitiesPerSecond

public WorkerOptions.Builder setMaxWorkerActivitiesPerSecond(double maxWorkerActivitiesPerSecond)

Maximum number of activities started per second by this worker. Default is 0 which means unlimited. If worker is not fully loaded while tasks are backing up on the service consider increasing setActivityPollThreadCount(int).

Note that this is a per worker limit. Use setMaxTaskQueueActivitiesPerSecond(double) to set per task queue limit across multiple workers.

setMaxConcurrentActivityExecutionSize

public WorkerOptions.Builder setMaxConcurrentActivityExecutionSize(int maxConcurrentActivityExecutionSize)

Maximum number of parallely executed activities.

Default is 200.

setMaxConcurrentWorkflowTaskExecutionSize

public WorkerOptions.Builder setMaxConcurrentWorkflowTaskExecutionSize(int maxConcurrentWorkflowTaskExecutionSize)

Maximum number of simultaneously executed workflow tasks. Note that this is not related to the total number of open workflows which do not need to be loaded in a worker when they are not making state transitions.

Default is 200.

setMaxConcurrentLocalActivityExecutionSize

public WorkerOptions.Builder setMaxConcurrentLocalActivityExecutionSize(int maxConcurrentLocalActivityExecutionSize)

Maximum number of parallely executed local activities.

Default is 200.

setMaxTaskQueueActivitiesPerSecond

public WorkerOptions.Builder setMaxTaskQueueActivitiesPerSecond(double maxTaskQueueActivitiesPerSecond)

Optional: Sets the rate limiting on number of activities that can be executed per second. This is managed by the server and controls activities per second for the entire task queue across all the workers. Notice that the number is represented in double, so that you can set it to less than 1 if needed. For example, set the number to 0.1 means you want your activity to be executed once every 10 seconds. This can be used to protect down stream services from flooding. The zero value of this uses the default value. Default is unlimited.

setWorkflowPollThreadCount

public WorkerOptions.Builder setWorkflowPollThreadCount(int workflowPollThreadCount)

Number of simultaneous poll requests on workflow task queue. Note that the majority of the workflow tasks will be using host local task queue due to caching. So try incrementing WorkerFactoryOptions.Builder.setWorkflowHostLocalPollThreadCount(int) before this one.

Default is 2.

setActivityPollThreadCount

public WorkerOptions.Builder setActivityPollThreadCount(int activityPollThreadCount)

Number of simultaneous poll requests on activity task queue. Consider incrementing if the worker is not throttled due to `MaxActivitiesPerSecond` or `MaxConcurrentActivityExecutionSize` options and still cannot keep up with the request rate.

Default is 5.

setLocalActivityWorkerOnly

public WorkerOptions.Builder setLocalActivityWorkerOnly(boolean localActivityWorkerOnly)

If set to true worker would only handle workflow tasks and local activities. Non-local activities will not be executed by this worker.

Default is false.

build

public WorkerOptions build()

validateAndBuildWithDefaults

public WorkerOptions validateAndBuildWithDefaults()