c

zio.temporal.activity

ZActivityStubBuilder

final class ZActivityStubBuilder[Res] extends AnyRef

Annotations
@deprecated
Deprecated

(Since version 0.6.0) Build ZActivityOptions and provide it directly

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZActivityStubBuilder
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def build: Res

    Builds ActivityStub

    Builds ActivityStub

    returns

    activity stub

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. def transformJavaOptions(f: (Builder) => Builder): ZActivityStubBuilder[Res]

    Allows to specify options directly on the java SDK's ActivityOptions.

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

    Note

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

  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. def withCancellationType(cancellationType: ActivityCancellationType): ZActivityStubBuilder[Res]

    In case of an activity's scope cancellation the corresponding activity stub call fails with a zio.temporal.failure.CanceledFailure

    In case of an activity's scope cancellation the corresponding activity stub call fails with a zio.temporal.failure.CanceledFailure

    cancellationType

    Defines the activity's stub cancellation mode. The default value is ActivityCancellationType.TRY_CANCEL

    See also

    ActivityCancellationType

  22. def withContextPropagators(propagators: ContextPropagator*): ZActivityStubBuilder[Res]

  23. def withContextPropagators(propagators: List[ContextPropagator]): ZActivityStubBuilder[Res]

    Note:
    This method has extremely limited usage.

    Note:
    This method has extremely limited usage. The majority of users should just set zio.temporal.workflow.ZWorkflowClientOptions.withContextPropagators

    Both "client" (workflow worker) and "server" (activity worker) sides of context propagation from a workflow to an activity exist in a worker process (potentially the same one), so they typically share the same worker options. Specifically, ContextPropagators specified on zio.temporal.workflow.ZWorkflowClientOptions.withContextPropagators.

    zio.temporal.workflow.ZWorkflowClientOptions.withContextPropagators is the right place to specify ContextPropagators between Workflow and an Activity.
    Specifying context propagators with this method overrides them only on the "client" (workflow) side and can't be automatically promoted to the "server" (activity worker), which always uses ContextPropagators from zio.temporal.workflow.ZWorkflowClientOptions.contextPropagators
    The only legitimate usecase for this method is probably a situation when the specific activity is implemented in a different language and in a completely different worker codebase and in that case setting a ContextPropagator that is applied only on a "client" side could make sense.
    This is also why there is no equivalent method on Local activity options.

    propagators

    specifies the list of context propagators to use during propagation from a workflow to the activity with these activity options. This list overrides the list specified on zio.temporal.workflow.ZWorkflowClientOptions.contextPropagators

    See also

    Rejected feature reqest for LocalActivityOption#contextPropagators

  24. def withDisableEagerExecution(value: Boolean): ZActivityStubBuilder[Res]

    If set to true, will not request eager execution regardless of worker settings.

    If set to true, will not request eager execution regardless of worker settings. If false, eager execution may still be disabled at the worker level or eager execution may not be requested due to lack of available slots.

    Eager activity execution means the server returns requested eager activities directly from the workflow task back to this worker which is faster than non-eager which may be dispatched to a separate worker.

    Defaults to false, meaning that eager activity execution will be requested if possible.

  25. def withHeartbeatTimeout(timeout: zio.Duration): ZActivityStubBuilder[Res]

    Heartbeat interval.

    Heartbeat interval. Activity must call ZActivityExecutionContext.heartbeat before this interval passes after the last heartbeat or the Activity starts.

  26. def withRetryOptions(options: ZRetryOptions): ZActivityStubBuilder[Res]

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

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

    If not provided, the server-defined default activity retry policy will be used. If not overridden, the server default activity retry policy is:

     InitialInterval: 1 second BackoffCoefficient: 2 MaximumInterval: 100 seconds // 100 * InitialInterval
    MaximumAttempts: 0 // Unlimited NonRetryableErrorTypes: [] 
    
    If both [[withScheduleToStartTimeout]] and [[ZRetryOptions.withMaximumAttempts]] are not set, the Activity will not be retried. To ensure zero retries, set [[ZRetryOptions.withMaximumAttempts]] to 1.

  27. def withScheduleToCloseTimeout(timeout: zio.Duration): ZActivityStubBuilder[Res]

    Total time that a workflow is willing to wait for an Activity to complete.

    Total time that a workflow is willing to wait for an Activity to complete.

    ScheduleToCloseTimeout limits the total time of an Activity's execution including retries withStartToCloseTimeout to limit the time of a single attempt).

    Either this option or withStartToCloseTimeout is required.

    Defaults to unlimited, which is chosen if set to null.

  28. def withScheduleToStartTimeout(timeout: zio.Duration): ZActivityStubBuilder[Res]

    Time that the Activity Task can stay in the Task Queue before it is picked up by a Worker.

    Time that the Activity Task can stay in the Task Queue before it is picked up by a Worker.

    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.

  29. def withStartToCloseTimeout(timeout: zio.Duration): ZActivityStubBuilder[Res]

    Maximum time of a single Activity attempt.

    Maximum time of a single Activity attempt.

    Note that the Temporal Server doesn't detect Worker process failures directly. It relies on this timeout to detect that an Activity that didn't complete on time. So this timeout should be as short as the longest possible execution of the Activity body. Potentially long-running Activities must specify HeartbeatTimeout and call ZActivityExecutionContext.heartbeat periodically for timely failure detection.

    If withScheduleToCloseTimeout is not provided, then this timeout is required.

  30. def withTaskQueue(taskQueue: String): ZActivityStubBuilder[Res]

    Task queue to use when dispatching activity task to a worker.

    Task queue to use when dispatching activity task to a worker. By default, it is the same task list name the workflow was started with.

  31. def withVersioningIntent(value: VersioningIntent): ZActivityStubBuilder[Res]

    Specifies whether this activity should run on a worker with a compatible Build Id or not.

    Specifies whether this activity should run on a worker with a compatible Build Id or not.

    See also

    VersioningIntent

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped