ZTestEnvironmentOptions

zio.temporal.testkit.ZTestEnvironmentOptions
See theZTestEnvironmentOptions companion object
final case class ZTestEnvironmentOptions

Represents ZTestEnvironment options.

Attributes

See also

TestEnvironmentOptions

Companion
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def toJava: TestEnvironmentOptions
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Any
def transformJavaOptions(f: Builder => Builder): ZTestEnvironmentOptions

Allows to specify options directly on the java SDK's TestEnvironmentOptions. Use it in case an appropriate withXXX method is missing

Allows to specify options directly on the java SDK's TestEnvironmentOptions. Use it in case an appropriate withXXX method is missing

Attributes

Note

the options specified via this method take precedence over those specified via other methods.

Set the initial time for the workflow virtual clock.

Set the initial time for the workflow virtual clock.

Default is current time

Attributes

Set the initial time for the workflow virtual clock, milliseconds since epoch.

Set the initial time for the workflow virtual clock, milliseconds since epoch.

Default is current time

Attributes

Sets the scope to be used for metrics reporting. Optional. Default is to not report metrics.

Sets the scope to be used for metrics reporting. Optional. Default is to not report metrics.

Note: Don't mock Scope in tests! If you need to verify the metrics behavior, create a real Scope and mock, stub or spy a reporter instance:

Value parameters

value

the scope to be used for metrics reporting.

Attributes

def withTarget(value: String): ZTestEnvironmentOptions

Optional parameter that defines an endpoint which will be used for the communication with standalone temporal service. Has no effect if withUseExternalService is set to false.

Optional parameter that defines an endpoint which will be used for the communication with standalone temporal service. Has no effect if withUseExternalService is set to false.

Defaults to 127.0.0.1:7233

Attributes

Set to true in order to make test environment use external temporal service or false for in-memory test implementation.

Set to true in order to make test environment use external temporal service or false for in-memory test implementation.

Attributes

Sets whether the TestWorkflowEnvironment will timeskip. If true, no actual wall-clock time will pass when a workflow sleeps or sets a timer.

Sets whether the TestWorkflowEnvironment will timeskip. If true, no actual wall-clock time will pass when a workflow sleeps or sets a timer.

Default is true

Attributes

def withWorkerFactoryOptions(value: ZWorkerFactoryOptions): ZTestEnvironmentOptions
def withWorkflowClientOptions(value: ZWorkflowClientOptions): ZTestEnvironmentOptions

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product