ZWorkflowClientOptions

zio.temporal.workflow.ZWorkflowClientOptions
See theZWorkflowClientOptions companion object
final case class ZWorkflowClientOptions

Represents Temporal workflow client options

Attributes

See also

WorkflowClientOptions

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: WorkflowClientOptions
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): ZWorkflowClientOptions

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

Allows to specify options directly on the java SDK's WorkflowClientOptions. 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.

def withContextPropagators(value: ContextPropagator*): ZWorkflowClientOptions

Value parameters

value

specifies the list of context propagators to use with the client.

Attributes

def withDataConverter(value: DataConverter): ZWorkflowClientOptions

Overrides a data converter implementation used serialize workflow and activity arguments and results.

Overrides a data converter implementation used serialize workflow and activity arguments and results.

Clears codecRegistry — when the user supplies a custom converter, the fail-fast registry check at ZWorkflowClient.make is disabled. Use withCodecRegistry or withCodecs if you want the check to stay in effect.

Attributes

def withIdentity(value: String): ZWorkflowClientOptions

Override human readable identity of the worker. Identity is used to identify a worker and is recorded in the workflow history events. For example when a worker gets an activity task the correspondent ActivityTaskStarted event contains the worker identity as a field.

Override human readable identity of the worker. Identity is used to identify a worker and is recorded in the workflow history events. For example when a worker gets an activity task the correspondent ActivityTaskStarted event contains the worker identity as a field.

Attributes

def withInterceptors(value: WorkflowClientInterceptor*): ZWorkflowClientOptions

Interceptor used to intercept workflow client calls.

Interceptor used to intercept workflow client calls.

Attributes

Set the namespace

Set the namespace

Attributes

def withQueryRejectCondition(value: QueryRejectCondition): ZWorkflowClientOptions

Should a query be rejected by closed and failed workflows.

Should a query be rejected by closed and failed workflows.

Default is QueryRejectCondition.QUERY_REJECT_CONDITION_UNSPECIFIED which means that closed and failed workflows are still queryable.

Attributes

Deprecated methods

Sets worker binary checksum, which gets propagated in all history events and can be used for auto-reset assuming that every build has a new unique binary checksum. Can be null.

Sets worker binary checksum, which gets propagated in all history events and can be used for auto-reset assuming that every build has a new unique binary checksum. Can be null.

Attributes

Deprecated
[Since version 0.3.0] use worker\'s buildId instead

use zio.temporal.worker.ZWorkerOptions.withBuildId instead.

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product