Package dev.restate.sdk.testing

Class RestateRunnerBuilder

java.lang.Object

dev.restate.sdk.testing.RestateRunnerBuilder

public class RestateRunnerBuilder
extends Object

Builder for RestateRunner.

See Also:

• RestateRunner

Method Summary

Modifier and Type	Method	Description
RestateRunnerBuilder	bind(ServiceDefinition<?> serviceDefinition)	Add a Restate service to the endpoint.
<O> RestateRunnerBuilder	bind(ServiceDefinition<O> serviceDefinition, O options)	Add a Restate service to the endpoint, setting the options.
RestateRunnerBuilder	bind(Object service)	Add a Restate service to the endpoint.
ManualRestateRunner	buildManualRunner()
RestateRunner	buildRunner()	Deprecated. If you use JUnit 5, use RestateTest
static RestateRunnerBuilder	create()
static RestateRunnerBuilder	of(RestateHttpEndpointBuilder endpointBuilder)	Create from RestateHttpEndpointBuilder.
RestateRunnerBuilder	withAdditionalEnv(String key, String value)	Add additional environment variables to the Restate container.
RestateRunnerBuilder	withConfigFile(String configFile)	Mount a config file in the Restate container.
RestateRunnerBuilder	withRestateContainerImage(String restateContainerImage)	Override the container image to use for the Restate runtime.

Methods inherited from class java.lang.Object

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

Method Details

withRestateContainerImage

public RestateRunnerBuilder withRestateContainerImage(String restateContainerImage)

Override the container image to use for the Restate runtime.

withAdditionalEnv

public RestateRunnerBuilder withAdditionalEnv(String key,
 String value)

Add additional environment variables to the Restate container.

withConfigFile

public RestateRunnerBuilder withConfigFile(String configFile)

Mount a config file in the Restate container.

bind

public RestateRunnerBuilder bind(Object service)

Add a Restate service to the endpoint. This will automatically discover the generated factory based on the class name.

You can also manually instantiate the ServiceDefinition using bind(ServiceDefinition).

bind

public RestateRunnerBuilder bind(ServiceDefinition<?> serviceDefinition)

Add a Restate service to the endpoint.

To set the options, use bind(ServiceDefinition, Object).

bind

public <O> RestateRunnerBuilder bind(ServiceDefinition<O> serviceDefinition,
 O options)

Add a Restate service to the endpoint, setting the options.

buildManualRunner

public ManualRestateRunner buildManualRunner()

Returns:

a ManualRestateRunner to start and stop the test infra manually.

buildRunner

@Deprecated
public RestateRunner buildRunner()

Deprecated.

If you use JUnit 5, use RestateTest

Returns:

a RestateRunner to be used as JUnit 5 Extension.

create

public static RestateRunnerBuilder create()

of

public static RestateRunnerBuilder of(RestateHttpEndpointBuilder endpointBuilder)

Create from RestateHttpEndpointBuilder.