Interface WorkflowServiceStubs

All Superinterfaces:

ServiceStubs<WorkflowServiceGrpc.WorkflowServiceBlockingStub,WorkflowServiceGrpc.WorkflowServiceFutureStub>

public interface WorkflowServiceStubs
extends ServiceStubs<WorkflowServiceGrpc.WorkflowServiceBlockingStub,WorkflowServiceGrpc.WorkflowServiceFutureStub>

Initializes and holds gRPC blocking and future stubs.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	HEALTH_CHECK_SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
WorkflowServiceStubsOptions	getOptions()
static WorkflowServiceStubs	newConnectedServiceStubs(WorkflowServiceStubsOptions options, Duration timeout)	Creates WorkflowService gRPC stubs and ensures connectivity with the server at the moment of creation.
static WorkflowServiceStubs	newInstance()	Deprecated. use newLocalServiceStubs().
static WorkflowServiceStubs	newInstance(WorkflowServiceGrpc.WorkflowServiceImplBase service, WorkflowServiceStubsOptions options)	Deprecated. use InProcessGRPCServer to manage in-memory server and corresponded channel outside the stubs.
static WorkflowServiceStubs	newInstance(WorkflowServiceStubsOptions options)	Deprecated. use newServiceStubs(WorkflowServiceStubsOptions) or newConnectedServiceStubs(WorkflowServiceStubsOptions, Duration).
static WorkflowServiceStubs	newLocalServiceStubs()	Creates WorkflowService gRPC stubs pointed on to the locally running Temporal Server.
static WorkflowServiceStubs	newServiceStubs(WorkflowServiceStubsOptions options)	Creates WorkflowService gRPC stubs.

Methods inherited from interface io.temporal.serviceclient.ServiceStubs

awaitTermination, blockingStub, connect, futureStub, getRawChannel, getServerCapabilities, healthCheck, isShutdown, isTerminated, shutdown, shutdownNow

Field Details

HEALTH_CHECK_SERVICE_NAME

static final String HEALTH_CHECK_SERVICE_NAME

See Also:

• Constant Field Values

Method Details

newLocalServiceStubs

static WorkflowServiceStubs newLocalServiceStubs()

Creates WorkflowService gRPC stubs pointed on to the locally running Temporal Server. The Server should be available on 127.0.0.1:7233

newServiceStubs

static WorkflowServiceStubs newServiceStubs(WorkflowServiceStubsOptions options)

Creates WorkflowService gRPC stubs.

This method creates stubs with "lazy" connectivity. The connection is not performed during the creation time and happens on the first request.
If you wish to perform a connection in an eager manner, call ServiceStubs.connect(Duration) after creation or use newConnectedServiceStubs(WorkflowServiceStubsOptions, Duration) instead of this method.

If the options contain plugins (via WorkflowServiceStubsOptions.Builder.setPlugins(WorkflowServiceStubsPlugin...)), this method applies them in two phases:

1. Configuration phase: Each plugin's configureServiceStubs method is called in forward (registration) order to modify the options builder
2. Connection phase: Each plugin's connectServiceClient method is called in reverse order to wrap the connection (first plugin wraps all others)

Migration Note: This method doesn't respect WorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean), ServiceStubsOptions.Builder.setHealthCheckAttemptTimeout(Duration) (boolean)} and ServiceStubsOptions.Builder.setHealthCheckTimeout(Duration) (boolean)}. This method is equivalent to WorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean) set.

Parameters:

options - stub options to use

newConnectedServiceStubs

static WorkflowServiceStubs newConnectedServiceStubs(WorkflowServiceStubsOptions options,
 @Nullable
 Duration timeout)

Creates WorkflowService gRPC stubs and ensures connectivity with the server at the moment of creation.

See newServiceStubs(WorkflowServiceStubsOptions) if you prefer a lazy version of this method that doesn't perform an eager connection. This method is functionally equivalent to a sequence of newServiceStubs(WorkflowServiceStubsOptions) and ServiceStubs.connect(Duration)

Migration Note: This method doesn't respect WorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean), ServiceStubsOptions.Builder.setHealthCheckAttemptTimeout(Duration) (boolean)} and ServiceStubsOptions.Builder.setHealthCheckTimeout(Duration) (boolean)}. This method is equivalent to WorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean) not set.

Parameters:

options - stub options to use

timeout - timeout to use in ServiceStubs.connect(Duration) call. If null, options.getRpcTimeout() will be used.

newInstance

@Deprecated
static WorkflowServiceStubs newInstance()

Deprecated.

use newLocalServiceStubs().

Create gRPC connection stubs using default options. The options default to the connection to the locally running temporal service.

newInstance

@Deprecated
static WorkflowServiceStubs newInstance(WorkflowServiceStubsOptions options)

Deprecated.

use newServiceStubs(WorkflowServiceStubsOptions) or newConnectedServiceStubs(WorkflowServiceStubsOptions, Duration). Use newServiceStubs(WorkflowServiceStubsOptions) to get the same behavior as with set WorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean) (preferred). Use newConnectedServiceStubs(WorkflowServiceStubsOptions, Duration) with {ServiceStubsOptions.Builder.setHealthCheckTimeout(Duration) as timeout (null if you didn't specify it).

Create gRPC connection stubs using provided options.

newInstance

@Deprecated
static WorkflowServiceStubs newInstance(WorkflowServiceGrpc.WorkflowServiceImplBase service,
 WorkflowServiceStubsOptions options)

Deprecated.

use InProcessGRPCServer to manage in-memory server and corresponded channel outside the stubs. Channel provided by InProcessGRPCServer should be supplied into newInstance(WorkflowServiceStubsOptions) by specifying {ServiceStubsOptions.getChannel()}

Create gRPC connection stubs that connect to the provided service implementation using an in-memory channel. Useful for testing, usually with mock and spy services.

getOptions

WorkflowServiceStubsOptions getOptions()