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 java.lang.String
HEALTH_CHECK_SERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description WorkflowServiceStubsOptions
getOptions()
static WorkflowServiceStubs
newConnectedServiceStubs(WorkflowServiceStubsOptions options, java.time.Duration timeout)
Creates WorkflowService gRPC stubs and ensures connectivity with the server at the moment of creation.static WorkflowServiceStubs
newInstance()
Deprecated.static WorkflowServiceStubs
newInstance(WorkflowServiceGrpc.WorkflowServiceImplBase service, WorkflowServiceStubsOptions options)
Deprecated.useInProcessGRPCServer
to manage in-memory server and corresponded channel outside the stubs.static WorkflowServiceStubs
newInstance(WorkflowServiceStubsOptions options)
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 Detail
-
HEALTH_CHECK_SERVICE_NAME
static final java.lang.String HEALTH_CHECK_SERVICE_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
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, callServiceStubs.connect(Duration)
after creation or usenewConnectedServiceStubs(WorkflowServiceStubsOptions, Duration)
instead of this method.Migration Note: This method doesn't respect
WorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean)
,ServiceStubsOptions.Builder.setHealthCheckAttemptTimeout(Duration)
(boolean)} andServiceStubsOptions.Builder.setHealthCheckTimeout(Duration)
(boolean)}. This method is equivalent toWorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean)
set.- Parameters:
options
- stub options to use
-
newConnectedServiceStubs
static WorkflowServiceStubs newConnectedServiceStubs(WorkflowServiceStubsOptions options, @Nullable java.time.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 ofnewServiceStubs(WorkflowServiceStubsOptions)
andServiceStubs.connect(Duration)
Migration Note: This method doesn't respect
WorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean)
,ServiceStubsOptions.Builder.setHealthCheckAttemptTimeout(Duration)
(boolean)} andServiceStubsOptions.Builder.setHealthCheckTimeout(Duration)
(boolean)}. This method is equivalent toWorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean)
not set.- Parameters:
options
- stub options to usetimeout
- timeout to use inServiceStubs.connect(Duration)
call. If null,options.getRpcTimeout()
will be used.
-
newInstance
@Deprecated static WorkflowServiceStubs newInstance()
Deprecated.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.usenewServiceStubs(WorkflowServiceStubsOptions)
ornewConnectedServiceStubs(WorkflowServiceStubsOptions, Duration)
. UsenewServiceStubs(WorkflowServiceStubsOptions)
to get the same behavior as with setWorkflowServiceStubsOptions.Builder.setDisableHealthCheck(boolean)
(preferred). UsenewConnectedServiceStubs(WorkflowServiceStubsOptions, Duration)
with {ServiceStubsOptions.Builder.setHealthCheckTimeout(Duration)
astimeout
(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.useInProcessGRPCServer
to manage in-memory server and corresponded channel outside the stubs. Channel provided byInProcessGRPCServer
should be supplied intonewInstance(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()
-
-