com.uber.cadence.serviceclient

Class WorkflowServiceTChannel.ClientOptions.Builder

java.lang.Object

com.uber.cadence.serviceclient.WorkflowServiceTChannel.ClientOptions.Builder

Enclosing class:

WorkflowServiceTChannel.ClientOptions

public static class WorkflowServiceTChannel.ClientOptions.Builder
extends java.lang.Object

Builder is the builder for ClientOptions.

Field Summary

Fields

Modifier and Type	Field and Description
long	rpcListArchivedWorkflowTimeoutMillis
long	rpcQueryTimeoutMillis
java.lang.String	serviceName

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
WorkflowServiceTChannel.ClientOptions	build() Builds and returns a ClientOptions object.
WorkflowServiceTChannel.ClientOptions.Builder	setClientAppName(java.lang.String clientAppName) Sets the client application name.
WorkflowServiceTChannel.ClientOptions.Builder	setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)
WorkflowServiceTChannel.ClientOptions.Builder	setListArchivedWorkflowRpcTimeout(long timeoutMillis) Sets the rpc timeout value for query calls.
WorkflowServiceTChannel.ClientOptions.Builder	setMetricsScope(com.uber.m3.tally.Scope metricsScope) Sets the metrics scope to be used for metrics reporting.
WorkflowServiceTChannel.ClientOptions.Builder	setQueryRpcTimeout(long timeoutMillis) Sets the rpc timeout value for query calls.
WorkflowServiceTChannel.ClientOptions.Builder	setRpcLongPollTimeout(long timeoutMillis) Sets the rpc timeout value for the following long poll based operations: PollForDecisionTask, PollForActivityTask, GetWorkflowExecutionHistory.
WorkflowServiceTChannel.ClientOptions.Builder	setRpcTimeout(long timeoutMillis) Sets the rpc timeout value for non query and non long poll calls.
WorkflowServiceTChannel.ClientOptions.Builder	setServiceName(java.lang.String serviceName) Sets the service name that Cadence service was started with.
WorkflowServiceTChannel.ClientOptions.Builder	setTransportHeaders(java.util.Map<java.lang.String,java.lang.String> transportHeaders) Sets additional transport headers for tchannel client.

Methods inherited from class java.lang.Object

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

Field Detail

rpcQueryTimeoutMillis

public long rpcQueryTimeoutMillis

rpcListArchivedWorkflowTimeoutMillis

public long rpcListArchivedWorkflowTimeoutMillis

serviceName

public java.lang.String serviceName

Constructor Detail

Builder

public Builder()

Method Detail

setRpcTimeout

public WorkflowServiceTChannel.ClientOptions.Builder setRpcTimeout(long timeoutMillis)

Sets the rpc timeout value for non query and non long poll calls. Default is 1000.

Parameters:

timeoutMillis - timeout, in millis.

setRpcLongPollTimeout

public WorkflowServiceTChannel.ClientOptions.Builder setRpcLongPollTimeout(long timeoutMillis)

Sets the rpc timeout value for the following long poll based operations: PollForDecisionTask, PollForActivityTask, GetWorkflowExecutionHistory. Should never be below 60000 as this is server side timeout for the long poll. Default is 61000.

Parameters:

timeoutMillis - timeout, in millis.

setQueryRpcTimeout

public WorkflowServiceTChannel.ClientOptions.Builder setQueryRpcTimeout(long timeoutMillis)

Sets the rpc timeout value for query calls. Default is 10000.

Parameters:

timeoutMillis - timeout, in millis.

setListArchivedWorkflowRpcTimeout

public WorkflowServiceTChannel.ClientOptions.Builder setListArchivedWorkflowRpcTimeout(long timeoutMillis)

Sets the rpc timeout value for query calls. Default is 180000.

Parameters:

timeoutMillis - timeout, in millis.

setClientAppName

public WorkflowServiceTChannel.ClientOptions.Builder setClientAppName(java.lang.String clientAppName)

Sets the client application name.

This name will be used as the tchannel client service name. It will also be reported as a tag along with metrics emitted to m3.

Parameters:

clientAppName - String representing the client application name.

Returns:

Builder for ClentOptions

setServiceName

public WorkflowServiceTChannel.ClientOptions.Builder setServiceName(java.lang.String serviceName)

Sets the service name that Cadence service was started with.

Parameters:

serviceName - String representing the service name

Returns:

Builder for ClentOptions

setMetricsScope

public WorkflowServiceTChannel.ClientOptions.Builder setMetricsScope(com.uber.m3.tally.Scope metricsScope)

Sets the metrics scope to be used for metrics reporting.

Parameters:

metricsScope -

Returns:

Builder for ClentOptions

setTransportHeaders

public WorkflowServiceTChannel.ClientOptions.Builder setTransportHeaders(java.util.Map<java.lang.String,java.lang.String> transportHeaders)

Sets additional transport headers for tchannel client.

Parameters:

transportHeaders - Map with additional transport headers

Returns:

Builder for ClentOptions

setHeaders

public WorkflowServiceTChannel.ClientOptions.Builder setHeaders(java.util.Map<java.lang.String,java.lang.String> headers)

build

public WorkflowServiceTChannel.ClientOptions build()

Builds and returns a ClientOptions object.

Returns:

ClientOptions object with the specified params.