Class WorkflowServiceStubsOptions

java.lang.Object

io.temporal.serviceclient.ServiceStubsOptions

io.temporal.serviceclient.WorkflowServiceStubsOptions

public final class WorkflowServiceStubsOptions
extends ServiceStubsOptions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	WorkflowServiceStubsOptions.Builder	Builder is the builder for ClientOptions.

Field Summary

Fields

Modifier and Type	Field	Description
static final Duration	DEFAULT_POLL_RPC_TIMEOUT	Default RPC timeout used for all long poll calls.
static final Duration	DEFAULT_QUERY_RPC_TIMEOUT	Default RPC timeout for workflow queries
static final Duration	DEFAULT_SERVER_LONG_POLL_RPC_TIMEOUT	RPC timeout used for all long poll calls on Temporal Server side.

Fields inherited from class io.temporal.serviceclient.ServiceStubsOptions

apiKeyProvided, channel, channelInitializer, connectionBackoffResetFrequency, DEFAULT_CONNECTION_BACKOFF_RESET_FREQUENCY, DEFAULT_GRPC_RECONNECT_FREQUENCY, DEFAULT_LOCAL_DOCKER_TARGET, DEFAULT_RPC_TIMEOUT, enableHttps, enableKeepAlive, grpcClientInterceptors, grpcCompression, grpcMetadataProviders, grpcReconnectFrequency, headers, healthCheckAttemptTimeout, healthCheckTimeout, keepAlivePermitWithoutStream, keepAliveTime, keepAliveTimeout, metricsScope, rpcTimeout, sslContext, systemInfoTimeout, target

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static WorkflowServiceStubsOptions	getDefaultInstance()
boolean	getDisableHealthCheck()	Deprecated. ServiceStubs don't perform health check on start anymore to allow lazy connectivity.
WorkflowServiceStubsPlugin[]	getPlugins()	Returns the service stubs plugins configured for this options.
Duration	getRpcLongPollTimeout()
Duration	getRpcQueryTimeout()
RpcRetryOptions	getRpcRetryOptions()
int	hashCode()
static WorkflowServiceStubsOptions.Builder	newBuilder()
static WorkflowServiceStubsOptions.Builder	newBuilder(ServiceStubsOptions options)
String	toString()

Methods inherited from class io.temporal.serviceclient.ServiceStubsOptions

getChannel, getChannelInitializer, getConnectionBackoffResetFrequency, getEnableHttps, getEnableKeepAlive, getGrpcClientInterceptors, getGrpcCompression, getGrpcMetadataProviders, getGrpcReconnectFrequency, getHeaders, getHealthCheckAttemptTimeout, getHealthCheckTimeout, getKeepAlivePermitWithoutStream, getKeepAliveTime, getKeepAliveTimeout, getMetricsScope, getRpcTimeout, getSslContext, getSystemInfoTimeout, getTarget

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_SERVER_LONG_POLL_RPC_TIMEOUT

public static final Duration DEFAULT_SERVER_LONG_POLL_RPC_TIMEOUT

RPC timeout used for all long poll calls on Temporal Server side. Long poll returns with an empty result after this server timeout.

DEFAULT_POLL_RPC_TIMEOUT

public static final Duration DEFAULT_POLL_RPC_TIMEOUT

Default RPC timeout used for all long poll calls.

DEFAULT_QUERY_RPC_TIMEOUT

public static final Duration DEFAULT_QUERY_RPC_TIMEOUT

Default RPC timeout for workflow queries

Method Details

newBuilder

public static WorkflowServiceStubsOptions.Builder newBuilder()

newBuilder

public static WorkflowServiceStubsOptions.Builder newBuilder(ServiceStubsOptions options)

getDefaultInstance

public static WorkflowServiceStubsOptions getDefaultInstance()

getDisableHealthCheck

@Deprecated
public boolean getDisableHealthCheck()

Deprecated.

ServiceStubs don't perform health check on start anymore to allow lazy connectivity. Users that prefer old behavior should explicitly call ServiceStubs.healthCheck() on client/stubs start and wait until it returns HealthCheckResponse.ServingStatus.SERVING

Returns:

false when client checks endpoint to make sure that the server is accessible.

getRpcLongPollTimeout

public Duration getRpcLongPollTimeout()

Returns:

Returns the rpc timout for long poll requests.

getRpcQueryTimeout

public Duration getRpcQueryTimeout()

Returns:

Returns the rpc timout for query workflow requests.

getRpcRetryOptions

public RpcRetryOptions getRpcRetryOptions()

Returns:

Returns rpc retry options for outgoing requests to the temporal server that supposed to be processed and returned fast, like start workflow (not long polls or awaits for workflow finishing).

getPlugins

public WorkflowServiceStubsPlugin[] getPlugins()

Returns the service stubs plugins configured for this options.

Returns:

the array of service stubs plugins, never null

equals

public boolean equals(Object o)

Overrides:

equals in class ServiceStubsOptions

hashCode

public int hashCode()

Overrides:

hashCode in class ServiceStubsOptions

toString

public String toString()

Overrides:

toString in class ServiceStubsOptions