final case class ZLocalActivityOptions extends Product with Serializable
Options used to configure how a local Activity is invoked.
- Alphabetic
- By Inheritance
- ZLocalActivityOptions
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- val doNotIncludeArgumentsIntoMarker: Option[Boolean]
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val localRetryThreshold: Option[zio.Duration]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val retryOptions: Option[ZRetryOptions]
- val scheduleToCloseTimeout: Option[zio.Duration]
- val scheduleToStartTimeout: Option[zio.Duration]
- val startToCloseTimeout: Option[zio.Duration]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toJava: LocalActivityOptions
Convert to Java SDK's LocalActivityOptions
- def transformJavaOptions(f: (Builder) => Builder): ZLocalActivityOptions
Allows to specify options directly on the java SDK's LocalActivityOptions.
Allows to specify options directly on the java SDK's LocalActivityOptions. Use it in case an appropriate
withXXXmethod is missing- Note
the options specified via this method take precedence over those specified via other methods.
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withDoNotIncludeArgumentsIntoMarker(value: Boolean): ZLocalActivityOptions
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.
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.
- def withLocalRetryThreshold(value: zio.Duration): ZLocalActivityOptions
Maximum time to wait between retries locally, while keeping the Workflow Task open via a Heartbeat.
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.
- def withRetryOptions(value: ZRetryOptions): ZLocalActivityOptions
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.
- See also
LocalActivityOptions.Builder
- def withScheduleToCloseTimeout(value: zio.Duration): ZLocalActivityOptions
- def withScheduleToStartTimeout(value: zio.Duration): ZLocalActivityOptions
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.
- def withStartToCloseTimeout(value: zio.Duration): ZLocalActivityOptions
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)