ZLocalActivityOptions

zio.temporal.activity.ZLocalActivityOptions
See theZLocalActivityOptions companion object
final case class ZLocalActivityOptions

Options used to configure how a local Activity is invoked.

Attributes

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: LocalActivityOptions

Convert to Java SDK's LocalActivityOptions

Convert to Java SDK's LocalActivityOptions

Attributes

def transformJavaOptions(f: Builder => Builder): ZLocalActivityOptions

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

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

When set to true, the serialized arguments of the local Activity are not included in the Marker Event that stores the local Activity's invocation result. The serialized arguments are included only for human troubleshooting as they are never read by the SDK code. In some cases, it is better to not include them to reduce the history size. The default value is set to false.

When set to true, the serialized arguments of the local Activity are not included in the Marker Event that stores the local Activity's invocation result. The serialized arguments are included only for human troubleshooting as they are never read by the SDK code. In some cases, it is better to not include them to reduce the history size. The default value is set to false.

Attributes

Maximum time to wait between retries locally, while keeping the Workflow Task open via a Heartbeat. If the delay between the attempts becomes larger that this threshold, a Workflow Timer will be scheduled. Default value is Workflow Task Timeout multiplied by 3.

Maximum time to wait between retries locally, while keeping the Workflow Task open via a Heartbeat. If the delay between the attempts becomes larger that this threshold, a Workflow Timer will be scheduled. Default value is Workflow Task Timeout multiplied by 3.

Attributes

ZRetryOptions that define how an Activity is retried in case of failure.

ZRetryOptions that define how an Activity is retried in case of failure.

If both scheduleToStartTimeout and ZRetryOptions.maximumAttempts are not set, the Activity will not be retried.

To ensure zero retries, set ZRetryOptions.maximumAttempts to 1.

Attributes

See also

LocalActivityOptions.Builder

Time that the Activity Task can stay in the Worker's internal Task Queue of Local Activities until it's picked up by the Local Activity Executor.

Time that the Activity Task can stay in the Worker's internal Task Queue of Local Activities until it's picked up by the Local Activity Executor.

ScheduleToStartTimeout is always non-retryable. Retrying after this timeout doesn't make sense as it would just put the Activity Task back into the same Task Queue.

Defaults to unlimited.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product