WorkerOptions.Builder (cadence-client 2.5.2 API)

java.lang.Object
- com.uber.cadence.worker.WorkerOptions.Builder

Enclosing class:: WorkerOptions

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

Constructor Summary

Constructors
Constructor and Description

Builder()

Constructors
Constructor and Description
`Builder()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`WorkerOptions`	`build()`
`WorkerOptions.Builder`	`setActivityPollerOptions(PollerOptions activityPollerOptions)`
`WorkerOptions.Builder`	`setDataConverter(DataConverter dataConverter)` Override a data converter implementation used by workflows and activities executed by this worker.
`WorkerOptions.Builder`	`setDisableActivityWorker(boolean disableActivityWorker)` When set to true doesn't poll on activity task list even if there are registered activities with a worker.
`WorkerOptions.Builder`	`setDisableWorkflowWorker(boolean disableWorkflowWorker)` When set to true doesn't poll on workflow task list even if there are registered workflows with a worker.
`WorkerOptions.Builder`	`setEnableLoggingInReplay(boolean enableLoggingInReplay)`
`WorkerOptions.Builder`	`setIdentity(java.lang.String identity)` Override human readable identity of the worker.
`WorkerOptions.Builder`	`setInterceptorFactory(java.util.function.Function<WorkflowInterceptor,WorkflowInterceptor> interceptorFactory)`
`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`	`setMaxConcurrentWorkflowExecutionSize(int maxConcurrentWorkflowExecutionSize)` Maximum number of parallely executed decision tasks.
`WorkerOptions.Builder`	`setMetricsScope(com.uber.m3.tally.Scope metricsScope)`
`WorkerOptions.Builder`	`setReportActivityCompletionRetryOptions(RetryOptions reportActivityCompletionRetryOptions)`
`WorkerOptions.Builder`	`setReportActivityFailureRetryOptions(RetryOptions reportActivityFailureRetryOptions)`
`WorkerOptions.Builder`	`setReportWorkflowCompletionRetryOptions(RetryOptions reportWorkflowCompletionRetryOptions)`
`WorkerOptions.Builder`	`setReportWorkflowFailureRetryOptions(RetryOptions reportWorkflowFailureRetryOptions)`
`WorkerOptions.Builder`	`setTaskListActivitiesPerSecond(double taskListActivitiesPerSecond)` Optional: Sets the rate limiting on number of activities that can be executed per second.
`WorkerOptions.Builder`	`setWorkerActivitiesPerSecond(double workerActivitiesPerSecond)` Maximum number of activities started per second.
`WorkerOptions.Builder`	`setWorkflowPollerOptions(PollerOptions workflowPollerOptions)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
public Builder()
```
- Method Detail
  - setDisableWorkflowWorker
```
public WorkerOptions.Builder setDisableWorkflowWorker(boolean disableWorkflowWorker)
```
    When set to true doesn't poll on workflow task list even if there are registered workflows with a worker. For clarity prefer not registing workflow types with a Worker to setting this option. But it can be useful for disabling polling through configuration without a code change.
  - setDisableActivityWorker
```
public WorkerOptions.Builder setDisableActivityWorker(boolean disableActivityWorker)
```
    When set to true doesn't poll on activity task list even if there are registered activities with a worker. For clarity prefer not registing activity implementations with a Worker to setting this option. But it can be useful for disabling polling through configuration without a code change.
  - setIdentity
```
public WorkerOptions.Builder setIdentity(java.lang.String identity)
```
    Override human readable identity of the worker. Identity is used to identify a worker and is recorded in the workflow history events. For example when a worker gets an activity task the correspondent ActivityTaskStarted event contains the worker identity as a field. Default is whatever (ManagementFactory.getRuntimeMXBean().getName() returns.
  - setDataConverter
```
public WorkerOptions.Builder setDataConverter(DataConverter dataConverter)
```
    Override a data converter implementation used by workflows and activities executed by this worker. Default is JsonDataConverter data converter.
  - setWorkerActivitiesPerSecond
```
public WorkerOptions.Builder setWorkerActivitiesPerSecond(double workerActivitiesPerSecond)
```
    Maximum number of activities started per second. Default is 0 which means unlimited.
  - setMaxConcurrentActivityExecutionSize
```
public WorkerOptions.Builder setMaxConcurrentActivityExecutionSize(int maxConcurrentActivityExecutionSize)
```
    Maximum number of parallely executed activities.
  - setMaxConcurrentWorkflowExecutionSize
```
public WorkerOptions.Builder setMaxConcurrentWorkflowExecutionSize(int maxConcurrentWorkflowExecutionSize)
```
    Maximum number of parallely executed decision tasks.
  - setMaxConcurrentLocalActivityExecutionSize
```
public WorkerOptions.Builder setMaxConcurrentLocalActivityExecutionSize(int maxConcurrentLocalActivityExecutionSize)
```
    Maximum number of parallely executed local activities.
  - setActivityPollerOptions
```
public WorkerOptions.Builder setActivityPollerOptions(PollerOptions activityPollerOptions)
```
  - setWorkflowPollerOptions
```
public WorkerOptions.Builder setWorkflowPollerOptions(PollerOptions workflowPollerOptions)
```
  - setReportActivityCompletionRetryOptions
```
public WorkerOptions.Builder setReportActivityCompletionRetryOptions(RetryOptions reportActivityCompletionRetryOptions)
```
  - setReportActivityFailureRetryOptions
```
public WorkerOptions.Builder setReportActivityFailureRetryOptions(RetryOptions reportActivityFailureRetryOptions)
```
  - setReportWorkflowCompletionRetryOptions
```
public WorkerOptions.Builder setReportWorkflowCompletionRetryOptions(RetryOptions reportWorkflowCompletionRetryOptions)
```
  - setReportWorkflowFailureRetryOptions
```
public WorkerOptions.Builder setReportWorkflowFailureRetryOptions(RetryOptions reportWorkflowFailureRetryOptions)
```
  - setInterceptorFactory
```
public WorkerOptions.Builder setInterceptorFactory(java.util.function.Function<WorkflowInterceptor,WorkflowInterceptor> interceptorFactory)
```
  - setMetricsScope
```
public WorkerOptions.Builder setMetricsScope(com.uber.m3.tally.Scope metricsScope)
```
  - setEnableLoggingInReplay
```
public WorkerOptions.Builder setEnableLoggingInReplay(boolean enableLoggingInReplay)
```
  - setTaskListActivitiesPerSecond
```
public WorkerOptions.Builder setTaskListActivitiesPerSecond(double taskListActivitiesPerSecond)
```
    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 your entire tasklist. 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: 100k
  - build
```
public WorkerOptions build()
```

Class WorkerOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Method Detail

setDisableWorkflowWorker

setDisableActivityWorker

setIdentity

setDataConverter

setWorkerActivitiesPerSecond

setMaxConcurrentActivityExecutionSize

setMaxConcurrentWorkflowExecutionSize

setMaxConcurrentLocalActivityExecutionSize

setActivityPollerOptions

setWorkflowPollerOptions

setReportActivityCompletionRetryOptions

setReportActivityFailureRetryOptions

setReportWorkflowCompletionRetryOptions

setReportWorkflowFailureRetryOptions

setInterceptorFactory

setMetricsScope

setEnableLoggingInReplay

setTaskListActivitiesPerSecond

build